From 1258249a19ea045c20d342d51c011ca83a639545 Mon Sep 17 00:00:00 2001 From: Sviatoslav Sydorenko Date: Thu, 4 Jan 2024 19:31:02 +0100 Subject: [PATCH] Move Sphinx build customization to env vars --- .readthedocs.yaml | 4 ++-- tox.ini | 8 ++++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 0f1b71ad0..51c5c810a 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -21,9 +21,9 @@ build: "${READTHEDOCS_VIRTUALENV_PATH}"/bin/python -Im tox -e build-docs --notest -vvvvv - >- + SPHINX_BUILDER=dirhtml + SPHINX_BUILD_OUTPUT_DIRECTORY="${READTHEDOCS_OUTPUT}"/html "${READTHEDOCS_VIRTUALENV_PATH}"/bin/python -Im tox -e build-docs --skip-pkg-install -q - -- - "${READTHEDOCS_OUTPUT}"/html ... diff --git a/tox.ini b/tox.ini index 853aad65d..ce1c8cce3 100644 --- a/tox.ini +++ b/tox.ini @@ -326,15 +326,17 @@ commands = # Build the html docs with Sphinx: {envpython} -m sphinx \ + {posargs:\ -j auto \ - -b html \ + -b {env:SPHINX_BUILDER:html} \ {tty:--color} \ -a \ -n \ -W --keep-going \ -d "{temp_dir}/.doctrees" \ . \ - {posargs:"{envdir}/docs_out"} + {env:SPHINX_BUILD_OUTPUT_DIRECTORY:"{envdir}/docs_out"} \ + } # Print out the output docs dir and a way to serve html: -{envpython} -c\ @@ -350,6 +352,8 @@ commands = changedir = {toxinidir}/docs isolated_build = true passenv = + SPHINX_BUILDER + SPHINX_BUILD_OUTPUT_DIRECTORY SSH_AUTH_SOCK skip_install = true