Skip to content

Commit 7c00820

Browse files
committed
πŸ› fix(docs): fix ReadTheDocs build
The RTD build failed because the trailing `--` in the tox invocation set posargs to empty, causing sphinx-build to receive no output directory. Remove the `--`, let tox use the default output path, and copy the result to `$READTHEDOCS_OUTPUT/html` where RTD expects it. Also fix two RST title underlines that were too short, which caused failures under `-W` (warnings as errors). Signed-off-by: BernΓ‘t GΓ‘bor <bgabor8@bloomberg.net>
1 parent 1696086 commit 7c00820

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

β€Ž.readthedocs.yamlβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ build:
55
commands:
66
- curl -LsSf https://astral.sh/uv/install.sh | sh
77
- ~/.local/bin/uv tool install tox --with tox-uv -p 3.14 --managed-python
8-
- ~/.local/bin/tox run -e docs --
8+
- ~/.local/bin/tox run -e docs -- "$READTHEDOCS_OUTPUT/html"

β€Ždocs/explanation.rstβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ How it works
22
============
33

44
Where does python-discovery look?
5-
-------------------------------
5+
---------------------------------
66

77
When you call :func:`~python_discovery.get_interpreter`, the library checks several locations in
88
order. It stops as soon as it finds an interpreter that matches your spec.

β€Ždocs/index.rstβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
python-discovery
2-
============
2+
================
33

44
You may have multiple Python versions installed on your machine -- system Python, versions from
55
`pyenv <https://github.com/pyenv/pyenv>`_, `mise <https://mise.jdx.dev/>`_,

0 commit comments

Comments
Β (0)