diff options
| author |   Fatih Degirmenci <fdegir@gmail.com> | 2018-09-20 08:14:40 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@opnfv.org> | 2018-09-20 08:14:40 +0000 |
| commit | f5968f2ad1fe036bfca986ceb8987f7142bc72f8 (patch) | |
| tree | 5edce27bb10c63eb9c55c21367269d7f17688d1c | |
| parent | da13cd230fb877bbaa3037116f01e774d44c4b31 (diff) | |
| parent | 94f6f507d27221cba18e7733e8545d605f98f66b (diff) | |
Merge "Docs transition"
| -rw-r--r-- | .gitignore | 6 | ||||
| -rw-r--r-- | docs/conf.py | 1 | ||||
| -rw-r--r-- | docs/conf.yaml | 3 | ||||
| -rw-r--r-- | docs/requirements.txt | 3 | ||||
| -rw-r--r-- | tox.ini | 25 |
5 files changed, 35 insertions, 3 deletions
@@ -1,6 +1,6 @@ *,~ .*.sw? -/docs_build/ +docs_build/* /docs_output/ /releng/ .idea @@ -33,7 +33,7 @@ coverage.xml nosetests.xml testapi_venv/ .cache -.tox +.tox/ *.retry job_output/ # Clear VM files @@ -42,7 +42,7 @@ job_output/ build.log *.d/ _static/ -conf.py *.html html/ xci/logs/ +docs/_build/* diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..86ab8c57 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1 @@ +from docs_conf.conf import * # flake8: noqa diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 00000000..305b679e --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: releng-xci diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..f26b0414 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +lfdocs-conf +sphinxcontrib-httpdomain +sphinx-opnfv-theme diff --git a/tox.ini b/tox.ini new file mode 100644 index 00000000..6aa16066 --- /dev/null +++ b/tox.ini @@ -0,0 +1,25 @@ +# Tox (http://tox.testrun.org/) is a tool for running tests +# in multiple virtualenvs. This configuration file will run the +# test suite on all supported python versions. To use it, "pip install tox" +# and then run "tox" from this directory. + +[tox] +envlist = docs,docs-linkcheck +skipsdist = True + +[testenv] +usedevelop = False +setenv= + HOME = {envtmpdir} + PYTHONPATH = {toxinidir} + +[testenv:docs] +deps = -r{toxinidir}/docs/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 = -r{toxinidir}/docs/requirements.txt +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs {toxinidir}/docs/_build/linkcheck |