diff options
| author |   Emma Foley <emma.l.foley@intel.com> | 2018-09-09 13:42:26 +0100 |
|---|---|---|
| committer |   Rex Lee <limingjiang@huawei.com> | 2018-11-09 13:01:34 +0000 |
| commit | dd400a996f7a0f6b763eea8b2e70d2fbc05a8421 (patch) | |
| tree | 78d96556fc6aa266739975f392579420cf6bc16b | |
| parent | 51cf862dbca0718be394a30ab346821698d835d3 (diff) | |
[docs] Transition to local docs build job.
Docs builds have transitioned to using local
build jobs. This allows Yardstick docs to be
built and verified locally.
The time taken to build and verify docs in the
gate for new changes should be reduced, as the
docs for each project will be built separately.
This change also allow contributers to test
their docs builds locally, using tox::
tox -e docs
tox -e docs-linkcheck
TODO: Update the dev guide to include new tox
environment
Related: DOCS-191
JIRA: YARDSTICK-1415
Signed-off-by: Emma Foley <emma.l.foley@intel.com>
Change-Id: Ib8bab85475dcd5127a2c41a2d55dce8f8d9da574
(cherry picked from commit 7203ff5925b805d07a5df53b6cdcf7d44cc4e4d1)
| -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} |