diff options
| author | Joshua Powers <josh.powers@canonical.com> | 2019-09-07 02:27:45 +0000 |
|---|---|---|
| committer | Server Team CI Bot <josh.powers+server-team-bot@canonical.com> | 2019-09-07 02:27:45 +0000 |
| commit | 385232dc8da6532b54342cd11e6d822ff7cd3e5a (patch) | |
| tree | ef0f51ecd8a348407cbea7662a3e55bc105e890d /tox.ini | |
| parent | c7688981e1070c75f3c3f31e707e7be272dd43d6 (diff) | |
| download | vyos-cloud-init-385232dc8da6532b54342cd11e6d822ff7cd3e5a.tar.gz vyos-cloud-init-385232dc8da6532b54342cd11e6d822ff7cd3e5a.zip | |
doc: document doc, create makefile and tox target
* Create makefile and tox targets for documentation building and testing
to better replicate the live web docs using the same theme.
* Created docs.rst to explain how to build and contribute to documentation
with style guide and tips.
* doc/rtd/conf.py:
* Add copyright to rtd config
* Use Sphinx's RTD theme to replicate actual docs
Diffstat (limited to 'tox.ini')
| -rw-r--r-- | tox.ini | 9 |
1 files changed, 7 insertions, 2 deletions
@@ -53,8 +53,13 @@ exclude = .venv,.tox,dist,doc,*egg,.git,build,tools [testenv:doc] basepython = python3 -deps = sphinx -commands = {envpython} -m sphinx {posargs:doc/rtd doc/rtd_html} +deps = + doc8 + sphinx + sphinx_rtd_theme +commands = + {envpython} -m sphinx {posargs:doc/rtd doc/rtd_html} + doc8 doc/rtd [testenv:xenial] commands = |