From 4b53bbc0a969ff79c89ff588eede8321b82e123b Mon Sep 17 00:00:00 2001 From: Daniel Hahler Date: Sat, 29 Feb 2020 00:47:30 +0100 Subject: [PATCH] docs: use doc/en/_build/html for html output (#6842) This will use the same directory as `make -C doc/en` then, and reflects the default location that Sphinx uses. --- CONTRIBUTING.rst | 2 +- changelog/README.rst | 2 +- tox.ini | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 57921de2f..050c7082c 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -86,7 +86,7 @@ without using a local copy. This can be convenient for small fixes. $ tox -e docs - The built documentation should be available in the ``doc/en/_build/``. + The built documentation should be available in ``doc/en/_build/html``. Where 'en' refers to the documentation language. diff --git a/changelog/README.rst b/changelog/README.rst index d91eb81e1..6d026f57e 100644 --- a/changelog/README.rst +++ b/changelog/README.rst @@ -34,4 +34,4 @@ If you are not sure what issue type to use, don't hesitate to ask in your PR. other than ``features`` it is usually better to stick to a single paragraph to keep it concise. You can also run ``tox -e docs`` to build the documentation -with the draft changelog (``doc/en/_build/changelog.html``) if you want to get a preview of how your change will look in the final release notes. +with the draft changelog (``doc/en/_build/html/changelog.html``) if you want to get a preview of how your change will look in the final release notes. diff --git a/tox.ini b/tox.ini index 2cdc7ad56..b9e042c13 100644 --- a/tox.ini +++ b/tox.ini @@ -85,7 +85,7 @@ commands = # the '-t changelog_towncrier_draft' tags makes sphinx include the draft # changelog in the docs; this does not happen on ReadTheDocs because it uses # the standard sphinx command so the 'changelog_towncrier_draft' is never set there - sphinx-build -W --keep-going -b html doc/en doc/en/_build -t changelog_towncrier_draft {posargs:} + sphinx-build -W --keep-going -b html doc/en doc/en/_build/html -t changelog_towncrier_draft {posargs:} [testenv:docs-checklinks] basepython = python3