Skip to content

Commit fe985de

Browse files
committed
fix docs
1 parent 6f8fd3d commit fe985de

File tree

5 files changed

+5
-2
lines changed

5 files changed

+5
-2
lines changed

.github/workflows/docs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,10 @@ jobs:
4646
- name: Install dependencies
4747
run: |
4848
python -m pip install -r docs/requirements.txt
49+
python -m pip install -e .
4950
5051
- name: Build documentation
51-
run: zensical build -f docs/mkdocs.yml
52+
run: zensical build -f docs/mkdocs.yml --strict
5253

5354
- uses: actions/upload-pages-artifact@v4
5455
with:

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ __pycache__
1414

1515
dist/
1616
oqtopus.egg-info/
17+
docs/site/

docs/docs/adding_modules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ modules:
3131
repository: wastewater
3232
```
3333
34-
::: oqtopus.core.ModuleConfig
34+
::: oqtopus.core.modules_config.ModuleConfig
3535
3636
### 3. Required fields
3737

docs/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ plugins:
4848
- mkdocstrings:
4949
handlers:
5050
python:
51+
paths: [..]
5152
options:
5253
show_signature: true
5354
show_signature_annotations: true

oqtopus/core/__init__.py

Whitespace-only changes.

0 commit comments

Comments
 (0)