Skip to content
Snippets Groups Projects
Commit a54c114b authored by David Douard's avatar David Douard
Browse files

template: simplify the docs/ scaffolding a bit

- remove the (mostly) useless sphinx-dev env
- install swh.docs in non-editable mode, and
- use the Makefiles provided by swh.docs as non-package data (in share/)
  instead of depending on the swh.docs sources to be available somewhere
  nearby.
parent 1ba76fb5
No related branches found
Tags v0.1.2
1 merge request!29template: simplify the docs/ scaffolding a bit
Pipeline #5514 passed
include ../../swh-docs/Makefile.sphinx
include swh-docs/Makefile.sphinx
......@@ -55,27 +55,11 @@ allowlist_externals = make
extras =
testing
deps =
# fetch and install swh-docs in develop mode
-e git+https://gitlab.softwareheritage.org/swh/devel/swh-docs.git\#egg=swh.docs
# fetch and install swh-docs
git+https://gitlab.softwareheritage.org/swh/devel/swh-docs.git\#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]
allowlist_externals = make
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
make -I {env_dir}/share/ -C docs
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment