diff options
| author |   Trevor Bramwell <tbramwell@linuxfoundation.org> | 2018-09-10 16:30:41 -0700 |
|---|---|---|
| committer | Trevor Bramwell <tbramwell@linuxfoundation.org> | 2018-09-10 16:31:34 -0700 |
| commit | 26fc7a76a06c83eae2a75a262953b3d8d9bb00b3 (patch) | |
| tree | 5682dc0a61debff58c7d97ee566a1ae224038f20 | |
| parent | 66b286618ed9ddb93fcaeebf999a5e48ddfa9768 (diff) | |
Local Docs Builds1.1.0
Added local sphinx documentation build following this guide:
https://docs.opnfv.org/en/latest/how-to-use-docs/local-build-transition.html
Change-Id: I8d0c430e6fff46dc1bf869fd54f304b0994aca8a
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
| -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 | 2 | ||||
| -rw-r--r-- | tox.ini | 10 |
5 files changed, 32 insertions, 1 deletions
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..e2c35e6 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: parser diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..b2c3b5d --- /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 + +.. _parser: + +====== +Parser +====== + +.. toctree:: + :maxdepth: 2 + + release/installation/index + release/release-notes/index + release/userguide/index 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 @@ -2,7 +2,7 @@ # such as verigraph [tox] minversion = 1.6 -envlist = py27,pep8 +envlist = py27,pep8,docs,docs-linkcheck skipsdist = True [testenv] @@ -24,3 +24,11 @@ whitelist_externals = commands = bash -c 'cd tosca2heat/tosca-parser; tox' +[testenv:docs] +deps = -rdocs/requirements.txt +commands = + sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + +[testenv:docs-linkcheck] +deps = -rdocs/requirements.txt +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck |