Skip to content

Commit f60bfd6

Browse files
authored
docs: Only enable mkdocs-jupyter on CI (#806)
mkdocs-jupyter is pretty slow and kinda annoying for local website dev, so we turn it off and only render it for the `CI` env var.
1 parent 3743f6d commit f60bfd6

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

DEVELOP.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,13 @@ Push a new tag to the main branch of the format `v*`. A new version will be publ
6868
The documentation website is generated with `mkdocs` and [`mkdocs-material`](https://squidfunk.github.io/mkdocs-material). You can serve the docs website locally with
6969

7070
```
71-
uv run mkdocs serve
71+
uv run --group docs mkdocs serve
7272
```
7373

7474
Publishing documentation happens automatically via CI when a new tag is published of the format `v*`. It can also be triggered manually through the Github Actions dashboard on [this page](https://github.com/developmentseed/lonboard/actions/workflows/deploy-mkdocs.yml). Note that publishing docs manually is **not advised if there have been new code additions since the last release** as the new functionality will be associated in the documentation with the tag of the _previous_ release. In this case, prefer publishing a new patch or minor release, which will publish both a new Python package and the new documentation for it.
75+
76+
Note that the `jupyter-mkdocs` plugin is only turned on when the `CI` env variable is set. If you're inspecting the docs with a Jupyter notebook, start the local dev server with:
77+
78+
```
79+
CI=true uv run --group docs mkdocs serve
80+
```

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,7 @@ plugins:
158158
- mkdocs-jupyter:
159159
include_source: true
160160
ignore: ["**/.ipynb_checkpoints/*.ipynb"]
161+
enabled: !ENV [CI, false]
161162
- mkdocstrings:
162163
enable_inventory: true
163164
handlers:

0 commit comments

Comments
 (0)