Skip to content

Commit a77870d

Browse files
authored
docs: reorganize using Diataxis framework (#988)
1 parent 6bc184f commit a77870d

33 files changed

+4296
-568
lines changed

.pre-commit-config.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,13 @@ repos:
2929
rev: "v3.8.1"
3030
hooks:
3131
- id: prettier
32+
- repo: https://github.com/LilSpazJoekp/docstrfmt
33+
rev: v2.0.2
34+
hooks:
35+
- id: docstrfmt
36+
args: ["-l", "120"]
37+
additional_dependencies: ["sphinx>=9.1"]
38+
exclude: ^docs/index\.rst$ # https://github.com/LilSpazJoekp/docstrfmt/issues/176
3239
- repo: https://github.com/astral-sh/ruff-pre-commit
3340
rev: v0.15.4
3441
hooks:

.readthedocs.yml

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
version: 2
22

33
build:
4-
os: ubuntu-22.04
5-
tools:
6-
python: "3.12"
4+
os: ubuntu-lts-latest
5+
tools: {}
76
commands:
8-
- asdf plugin add uv
9-
- asdf install uv latest
10-
- asdf global uv latest
11-
- uv run --no-dev --group docs sphinx-build -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html
7+
- curl -LsSf https://astral.sh/uv/install.sh | sh
8+
- ~/.local/bin/uv tool install tox --with tox-uv -p 3.14 --managed-python
9+
- ~/.local/bin/tox run -e docs --

0 commit comments

Comments
 (0)