diff options
| author |   Trevor Bramwell <tbramwell@linuxfoundation.org> | 2018-09-10 15:09:45 -0700 |
|---|---|---|
| committer | Trevor Bramwell <tbramwell@linuxfoundation.org> | 2018-10-22 11:22:41 -0700 |
| commit | 7c525d126453994f720897a9845722557ba3a165 (patch) | |
| tree | 3e4f14ee3ea6e7ae48c55f7fe4c7824b2fe51613 | |
| parent | 560eb13d6468f142d6aaaae78f85bc22a6acc7cf (diff) | |
Adds local documentation builds following this guide:
https://docs.opnfv.org/en/latest/how-to-use-docs/local-build-transition.html
docs can be build with
tox -e docs
Going forward docs will be hosted here:
https://opnfv-daisy.readthedocs.io/en/latest/
Change-Id: Iecb230463dfb96101cc5cf01af71cb54318ca732
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 | 20 | ||||
| -rw-r--r-- | docs/release/installation/index.rst | 2 | ||||
| -rw-r--r-- | docs/requirements.txt | 2 | ||||
| -rw-r--r-- | tox.ini | 10 |
6 files changed, 37 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..eb12e74b --- /dev/null +++ b/docs/conf.py @@ -0,0 +1 @@ +from docs_conf.conf import * # noqa: F401,F403 diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 00000000..bb1beaa1 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: daisy diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..e6ae4c9b --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,20 @@ +.. 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 + +.. _daisy: + +========= +Daisy4NFV +========= + +.. toctree:: + :maxdepth: 2 + + release/installation/index + release/configguide/index + release/release-notes/index + development/design/index + development/requirement/multicast + test diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst index 611ecf63..3080e14b 100644 --- a/docs/release/installation/index.rst +++ b/docs/release/installation/index.rst @@ -8,7 +8,7 @@ OPNFV Daisy4nfv Installation Guide ********************************** .. toctree:: - :numbered: + :numbered: :maxdepth: 4 introduction.rst diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..9fde2df2 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +lfdocs-conf +sphinx_opnfv_theme @@ -25,9 +25,19 @@ setenv= PYTHONPATH = {toxinidir} [testenv:pep8] +usedevelop = False deps = flake8 commands = flake8 {toxinidir} +[testenv:docs] +usedevelop = False +deps = -rdocs/requirements.txt +commands = + sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + +[testenv:docs-linkcheck] +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck + [flake8] # H803 skipped on purpose per list discussion. # E123, E125 skipped as they are invalid PEP-8. |