p53209761
/
test_ok2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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.
This commit is contained in:
Daniel Hahler 2020-02-29 00:47:30 +01:00 committed by GitHub
parent 769ffc32bf
commit 4b53bbc0a9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.rst
View File

@ -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.

2
changelog/README.rst
View File

@ -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.

2
tox.ini
View File

@ -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