From 7c00820f26959ecd33c20220d0b21bc3d9b74891 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bern=C3=A1t=20G=C3=A1bor?= Date: Wed, 25 Feb 2026 17:20:06 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=90=9B=20fix(docs):=20fix=20ReadTheDocs?= =?UTF-8?q?=20build?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- .readthedocs.yaml | 2 +- docs/explanation.rst | 2 +- docs/index.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 60e9a43..a6066a8 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -5,4 +5,4 @@ build: commands: - curl -LsSf https://astral.sh/uv/install.sh | sh - ~/.local/bin/uv tool install tox --with tox-uv -p 3.14 --managed-python - - ~/.local/bin/tox run -e docs -- + - ~/.local/bin/tox run -e docs -- "$READTHEDOCS_OUTPUT/html" diff --git a/docs/explanation.rst b/docs/explanation.rst index 9b219d2..3b65f4f 100644 --- a/docs/explanation.rst +++ b/docs/explanation.rst @@ -2,7 +2,7 @@ How it works ============ Where does python-discovery look? -------------------------------- +--------------------------------- When you call :func:`~python_discovery.get_interpreter`, the library checks several locations in order. It stops as soon as it finds an interpreter that matches your spec. diff --git a/docs/index.rst b/docs/index.rst index 4f0bd7b..6e1e622 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ python-discovery -============ +================ You may have multiple Python versions installed on your machine -- system Python, versions from `pyenv `_, `mise `_,