tox: Add sphinx environments to check sane doc build
Enable to check package documentation can be built without producing sphinx warnings. The sphinx environment is designed to be used in continuous integration in order to prevent breaking documentation build when committing changes. The sphinx-dev environment is designed to be used inside a full swh development environment. Related to T3258
This commit is contained in:
parent
18b68bd8c7
commit
6f8dd5d3f2
1 changed files with 38 additions and 0 deletions
38
tox.ini
38
tox.ini
|
@ -37,3 +37,41 @@ deps =
|
|||
mypy
|
||||
commands =
|
||||
mypy swh
|
||||
|
||||
# build documentation outside swh-environment using the current
|
||||
# git HEAD of swh-docs, is executed on CI for each diff to prevent
|
||||
# breaking doc build
|
||||
[testenv:sphinx]
|
||||
whitelist_externals = make
|
||||
usedevelop = true
|
||||
extras =
|
||||
testing
|
||||
deps =
|
||||
# fetch and install swh-docs in develop mode
|
||||
-e git+https://forge.softwareheritage.org/source/swh-docs#egg=swh.docs
|
||||
|
||||
setenv =
|
||||
SWH_PACKAGE_DOC_TOX_BUILD = 1
|
||||
# turn warnings into errors
|
||||
SPHINXOPTS = -W
|
||||
commands =
|
||||
make -I ../.tox/sphinx/src/swh-docs/swh/ -C docs
|
||||
|
||||
|
||||
# build documentation only inside swh-environment using local state
|
||||
# of swh-docs package
|
||||
[testenv:sphinx-dev]
|
||||
whitelist_externals = make
|
||||
usedevelop = true
|
||||
extras =
|
||||
testing
|
||||
deps =
|
||||
# install swh-docs in develop mode
|
||||
-e ../swh-docs
|
||||
|
||||
setenv =
|
||||
SWH_PACKAGE_DOC_TOX_BUILD = 1
|
||||
# turn warnings into errors
|
||||
SPHINXOPTS = -W
|
||||
commands =
|
||||
make -I ../.tox/sphinx-dev/src/swh-docs/swh/ -C docs
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue