mirror of
https://github.com/ClementTsang/bottom.git
synced 2025-07-27 07:34:27 +02:00
docs: update requirements.txt and bump to 3.11 (#1011)
This commit is contained in:
parent
a94a8059da
commit
bce95c0d48
4
.github/workflows/docs.yml
vendored
4
.github/workflows/docs.yml
vendored
@ -25,9 +25,9 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
- uses: actions/setup-python@v4.3.0
|
- uses: actions/setup-python@v4.5.0
|
||||||
with:
|
with:
|
||||||
python-version: 3.9
|
python-version: 3.11
|
||||||
|
|
||||||
- name: Install Python dependencies
|
- name: Install Python dependencies
|
||||||
run: pip install -r docs/requirements.txt
|
run: pip install -r docs/requirements.txt
|
||||||
|
4
.github/workflows/post-release.yml
vendored
4
.github/workflows/post-release.yml
vendored
@ -35,9 +35,9 @@ jobs:
|
|||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
- uses: actions/setup-python@v4.3.0
|
- uses: actions/setup-python@v4.5.0
|
||||||
with:
|
with:
|
||||||
python-version: 3.9
|
python-version: 3.11
|
||||||
|
|
||||||
- name: Install Python dependencies
|
- name: Install Python dependencies
|
||||||
run: pip install -r docs/requirements.txt
|
run: pip install -r docs/requirements.txt
|
||||||
|
4
.github/workflows/test-docs.yml
vendored
4
.github/workflows/test-docs.yml
vendored
@ -33,9 +33,9 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
- uses: actions/setup-python@v4.3.0
|
- uses: actions/setup-python@v4.5.0
|
||||||
with:
|
with:
|
||||||
python-version: 3.9
|
python-version: 3.11
|
||||||
|
|
||||||
- name: Install Python dependencies
|
- name: Install Python dependencies
|
||||||
run: pip install -r docs/requirements.txt
|
run: pip install -r docs/requirements.txt
|
||||||
|
@ -3,6 +3,8 @@
|
|||||||
This is where the extended documentation resides, hosted on GitHub Pages. We use [MkDocs](https://www.mkdocs.org/),
|
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).
|
[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
|
## Running locally
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
@ -35,10 +35,13 @@ There are a few areas where documentation changes are often needed:
|
|||||||
|
|
||||||
<h3>Extended documentation</h3>
|
<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
|
You can do so through `pip` or your system's package managers. If you use `pip`, you can use venv to cleanly install
|
||||||
documentation dependencies:
|
the documentation dependencies:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Change directories to the documentation.
|
# Change directories to the documentation.
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
mkdocs == 1.4.1
|
mkdocs == 1.4.2
|
||||||
mkdocs-material == 8.5.7
|
mkdocs-material == 9.0.10
|
||||||
mkdocs-material-extensions == 1.1.0
|
mkdocs-material-extensions == 1.1.0
|
||||||
mdx_truly_sane_lists == 1.3
|
mdx_truly_sane_lists == 1.3
|
||||||
mike == 1.1.2
|
mike == 1.1.2
|
||||||
|
Loading…
x
Reference in New Issue
Block a user