diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2018-09-18 11:06:02 -0400 |
|---|---|---|
| committer |   mbeierl <mark.beierl@dell.com> | 2018-09-18 14:28:25 -0400 |
| commit | f2548eacf2ae70f90bf486714fabf09a11d5d15d (patch) | |
| tree | ba645015fed7a08fd3feb4cbb85f6617e2e427ca | |
| parent | 5f84c19c4511da6706a501308b509aacbc6219de (diff) | |
Local Documentation Builds
This adds configuration for performing local documentation builds
with the following simple command:
tox -e docs
Change-Id: I8d7b3af60c12f4d426e3d6fc64eae66b356d94a6
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
| -rw-r--r-- | .gitignore | 3 | ||||
| -rw-r--r-- | docs/conf.py | 1 | ||||
| -rw-r--r-- | docs/conf.yaml | 3 | ||||
| -rw-r--r-- | docs/index.rst | 6 | ||||
| -rw-r--r-- | docs/requirements.txt | 2 | ||||
| -rw-r--r-- | tox.ini | 17 |
6 files changed, 28 insertions, 4 deletions
@@ -10,5 +10,6 @@ cover storperf.egg-info *.db ci/job -docs_build docs_output +.tox +docs/_build/* diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..3c4453e --- /dev/null +++ b/docs/conf.py @@ -0,0 +1 @@ +from docs_conf.conf import * diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..a665899 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: STORPERF diff --git a/docs/index.rst b/docs/index.rst index 5ed81af..c25a577 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -39,15 +39,15 @@ StorPerf User Guide ./testing/user/storperf-reporting.rst ****************************** -StorPerf Dev Guide +StorPerf Developer Guide ****************************** .. toctree:: - :caption: StorPerf Dev Guide + :caption: StorPerf Developer Guide :maxdepth: 5 :numbered: 5 - ./dev/index.rst + ./testing/developer/devguide/index.rst Indices diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..9fde2df --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +lfdocs-conf +sphinx_opnfv_theme @@ -0,0 +1,17 @@ +[tox] +minversion = 1.6 +envlist = + docs, + docs-linkcheck +skipsdist = true + +[testenv:docs] +deps = -rdocs/requirements.txt +commands = + sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +whitelist_externals = echo + +[testenv:docs-linkcheck] +deps = -rdocs/requirements.txt +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck |