Skip to content

Commit 1dda879

Browse files
committed
fix docs action
1 parent c369ea5 commit 1dda879

2 files changed

Lines changed: 13 additions & 12 deletions

File tree

.github/workflows/actions.yml

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -63,16 +63,14 @@ jobs:
6363
if: ${{ github.ref == 'refs/heads/main' }}
6464
runs-on: ubuntu-latest
6565
steps:
66-
- name: Checkout 🔖
67-
uses: actions/checkout@v3
68-
- name: Setup python 🐍
69-
uses: actions/setup-python@v4
70-
with:
71-
python-version: "3.11"
72-
- name: Build and push docs 📔🚀
73-
run: |
74-
pip install -r requirements-docs.txt
75-
mkdocs gh-deploy --force
66+
- name: Checkout 🔖
67+
uses: actions/checkout@v3
68+
- name: Deploy docs
69+
uses: mhausenblas/mkdocs-deploy-gh-pages@master
70+
env:
71+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
72+
CONFIG_FILE: mkdocs.yml
73+
REQUIREMENTS: requirements-docs.txt
7674

7775
pypi-release:
7876
needs: [test, check-style]

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,34 @@ Data-as-Code (DaC) `dac` is a tool that supports the distribution of data as (py
1515
Anything MAY change at any time. The public API SHOULD NOT be considered stable.").
1616
While in this phase, we will denote breaking changes with a minor increase.
1717

18-
1918
## 📔 [User documentation](https://data-as-code.github.io/dac/)
2019

21-
2220
## Setup development environment (for contributors only)
2321

2422
* Create a virtual environment and activate it
23+
2524
```shell
2625
python -m venv venv
2726
. venv/bin/activate
2827
```
2928

3029
* Install the developer dependencies
30+
3131
```shell
3232
python -m pip install -U pip wheel setuptools
3333
python -m pip install -r requirements-dev.txt
3434
```
3535

3636
* Enable the pre-commits
37+
3738
```shell
3839
pre-commit install
3940
```
4041

4142
* To run all the tests
43+
4244
```shell
4345
pytest --run-slow
4446
```
47+
4548
(omit `--run-slow` to run only the fast unit tests)

0 commit comments

Comments
 (0)