Skip to content

Commit 52d14f8

Browse files
committed
Update doc builder dependencies
- move from python3.8 to python3.11 - move from mkdocs to properdocs (fork of mkdocs b/c mkdocs no longer continuing support) - use poetry instead of requirements.txt for dependency management to make changes easier
1 parent 0407f95 commit 52d14f8

6 files changed

Lines changed: 1806 additions & 88 deletions

File tree

.github/workflows/publish-docs.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
runs-on: ubuntu-latest
1111
strategy:
1212
matrix:
13-
python-version: [3.8]
13+
python-version: [3.11]
1414
steps:
1515
- name: checkout
1616
uses: actions/checkout@v1
@@ -23,9 +23,10 @@ jobs:
2323
- name: install dependencies
2424
run: |
2525
python -m pip install --upgrade pip setuptools
26-
pip install -r requirements.txt
26+
pip install poetry
27+
poetry install
2728
- run: bash docs/build_external.sh
28-
- run: mkdocs build
29+
- run: properdocs build
2930
- name: Deploy
3031
uses: peaceiris/actions-gh-pages@v3
3132
with:

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,16 @@ will be updated on merge to the master branch of this repository.
2727
First, set up a virtual environment (Optional but recommended)
2828

2929
```bash
30-
python3.8 -m venv venv
30+
python3.11 -m venv venv
3131
source venv/bin/activate
3232
pip install -U setuptools pip
3333
```
3434

3535
Install the python dependencies
3636

3737
```bash
38-
pip install -r requirements.txt
38+
pip install poetry
39+
poetry install
3940
```
4041

4142
Run the script to pull the other respository files
@@ -47,5 +48,5 @@ bash docs/build_external.sh
4748
And finally serve the documentation for viewing locally with
4849

4950
```bash
50-
mkdocs serve
51+
properdocs serve
5152
```

0 commit comments

Comments
 (0)