diff options
| author |   Rex Lee <limingjiang@huawei.com> | 2018-10-17 03:26:58 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@opnfv.org> | 2018-10-17 03:26:58 +0000 |
| commit | 622a85f72bea2679ef4849abb083616bff3da0e7 (patch) | |
| tree | 14137bb7ab65d46b73c19f0e27850dec22580aaf | |
| parent | bb8a40544fdac7c9c5311b42993bf93f2d4da903 (diff) | |
| parent | 7203ff5925b805d07a5df53b6cdcf7d44cc4e4d1 (diff) | |
Merge "[docs] Transition to local docs build job."
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | docs/conf.py | 1 | ||||
| -rw-r--r-- | docs/conf.yaml | 3 | ||||
| -rw-r--r-- | docs/index.rst | 17 | ||||
| -rw-r--r-- | docs/requirements.txt | 5 | ||||
| -rw-r--r-- | tox.ini | 11 |
6 files changed, 39 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore index 8be48ac62..79e351fce 100644 --- a/.gitignore +++ b/.gitignore @@ -33,3 +33,5 @@ cover/ .idea/ # tox virtualenvs .tox/ +# docs build artifacts +docs/_build/* diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..86fddf13e --- /dev/null +++ b/docs/conf.py @@ -0,0 +1 @@ +from docs_conf.conf import * # pylint: disable=wildcard-import diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 000000000..01e08ec7f --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: Yardstick diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..e1339b0dd --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,17 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +.. _yardstick: + +========= +Yardstick +========= + +.. toctree:: + :numbered: + :maxdepth: 2 + + release/release-notes/index + testing/user/userguide/index + testing/developer/devguide/index diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 000000000..440843584 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,5 @@ +lfdocs-conf +sphinx_opnfv_theme +# Uncomment the following line if your project uses Sphinx to document +# HTTP APIs +# sphinxcontrib-httpdomain @@ -44,6 +44,17 @@ commands = basepython = python3 commands = {[testenv:functional]commands} +[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 + [testenv:os-requirements] commands = python {toxinidir}/tools/os-requirements-check.py {envdir} |