diff options
| author |   Cédric Ollivier <cedric.ollivier@orange.com> | 2021-11-22 14:21:29 +0100 |
|---|---|---|
| committer |   thmsdt <thomas.kulik@telekom.de> | 2021-11-30 15:08:21 +0100 |
| commit | 3093269296e267427debd31e180ac29fcab349df (patch) | |
| tree | 6e7fdf81aa384b9303dc2603e8b3420c969abc7f /examples/sphinx/master/tox.ini | |
| parent | d6b7f66b0d3cbc4e7c92a85837a8e74906c08434 (diff) | |
Make examples buildable
It now excludes .tox from conf.py.
It locally clones docutils cheatsheet as examples (it should be noted
that cheatsheet.txt is renamed index.rst in it).
[1] https://docutils.sourceforge.io/docs/user/rst/cheatsheet.txt
Issue-ID: DOC-772
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
Change-Id: Ifd616b797d5a48da5df77b0dfaa0613497b742d8
Diffstat (limited to 'examples/sphinx/master/tox.ini')
| -rw-r--r-- | examples/sphinx/master/tox.ini | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/examples/sphinx/master/tox.ini b/examples/sphinx/master/tox.ini new file mode 100644 index 000000000..9057fb77f --- /dev/null +++ b/examples/sphinx/master/tox.ini @@ -0,0 +1,25 @@ +[tox] +minversion = 1.6 +envlist = docs,docs-linkcheck +skipsdist = true + +[testenv:docs] +basepython = python3 +deps = + -r{toxinidir}/requirements-docs.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt?h=master + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master +commands = + sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html + echo "Generated docs available in {toxinidir}/_build/html" +whitelist_externals = + echo + +[testenv:docs-linkcheck] +basepython = python3 +deps = + -r{toxinidir}/requirements-docs.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt?h=master + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master +commands = + sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck |