summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorClement Tsang <34804052+ClementTsang@users.noreply.github.com>2023-02-03 03:25:25 -0500
committerGitHub <noreply@github.com>2023-02-03 03:25:25 -0500
commitbce95c0d4859c6e2b0e5763d4027a18cad51f34a (patch)
treefc475b4105108cafeb946e8189d790e86296bbb9 /docs
parenta94a8059da0c523b4bebee2a99fc071a99689bcc (diff)
docs: update requirements.txt and bump to 3.11 (#1011)
Diffstat (limited to 'docs')
-rw-r--r--docs/README.md2
-rw-r--r--docs/content/contribution/documentation.md9
-rw-r--r--docs/requirements.txt4
3 files changed, 10 insertions, 5 deletions
diff --git a/docs/README.md b/docs/README.md
index 33d89d17..528822e8 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -3,6 +3,8 @@
This is where the extended documentation resides, hosted on GitHub Pages. We use [MkDocs](https://www.mkdocs.org/),
[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/), and [mike](https://github.com/jimporter/mike).
+Documentation is currently built using Python 3.11, though it should work fine with older versions.
+
## Running locally
```bash
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.
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 763a3654..5cadfc7a 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,5 +1,5 @@
-mkdocs == 1.4.1
-mkdocs-material == 8.5.7
+mkdocs == 1.4.2
+mkdocs-material == 9.0.10
mkdocs-material-extensions == 1.1.0
mdx_truly_sane_lists == 1.3
mike == 1.1.2