diff options
Diffstat (limited to 'docs/content/contribution/documentation.md')
| -rw-r--r-- | docs/content/contribution/documentation.md | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/content/contribution/documentation.md b/docs/content/contribution/documentation.md index 5a1a6ad6..616f3319 100644 --- a/docs/content/contribution/documentation.md +++ b/docs/content/contribution/documentation.md @@ -35,10 +35,13 @@ There are a few areas where documentation changes are often needed: <h3>Extended documentation</h3> - For changes to the extended documentation, you'll probably want [MkDocs](https://www.mkdocs.org/), [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/), `mdx_truly_sane_lists`, and optionally [Mike](https://github.com/jimporter/mike) installed to provide live reloading and preview for your changes. They aren't needed but it'll help with validating your changes. + For changes to the extended documentation, you'll probably want Python 3.11 (older versions should be fine though), + [MkDocs](https://www.mkdocs.org/), [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/), + `mdx_truly_sane_lists`, and optionally [Mike](https://github.com/jimporter/mike) installed to provide live reloading + and preview for your changes. They aren't needed but it'll help with validating your changes. - You can do so through `pip` or your system's package managers. If you use `pip`, you can use venv to install the - documentation dependencies: + You can do so through `pip` or your system's package managers. If you use `pip`, you can use venv to cleanly install + the documentation dependencies: ```bash # Change directories to the documentation. |