diff options
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | docs/conf.py | 1 | ||||
| -rw-r--r-- | docs/conf.yaml | 3 | ||||
| -rw-r--r-- | docs/development/index.rst | 16 | ||||
| -rw-r--r-- | docs/index.rst | 15 | ||||
| -rw-r--r-- | docs/release/index.rst | 18 | ||||
| -rw-r--r-- | docs/requirements.txt | 2 | ||||
| -rw-r--r-- | tox.ini | 20 |
8 files changed, 77 insertions, 0 deletions
@@ -4,3 +4,5 @@ *pyc /sfc.egg-info/ *ovs-logs/ +.tox/ +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..d38bbda4 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: sfc diff --git a/docs/development/index.rst b/docs/development/index.rst new file mode 100644 index 00000000..5644372b --- /dev/null +++ b/docs/development/index.rst @@ -0,0 +1,16 @@ +.. 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 + +.. _sfc-development: + +========================= +Development Documentation +========================= + +.. toctree:: + :numbered: + :maxdepth: 2 + + requirements/index + design/index diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..73e87a9b --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,15 @@ +.. 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 + +.. _sfc: + +========================= +Service Function Chaining +========================= + +.. toctree:: + :maxdepth: 1 + + release/index + development/index diff --git a/docs/release/index.rst b/docs/release/index.rst new file mode 100644 index 00000000..2fc72e92 --- /dev/null +++ b/docs/release/index.rst @@ -0,0 +1,18 @@ +.. 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 + +.. _sfc-release: + +==================== +Release Documetation +==================== + +.. toctree:: + :numbered: + :maxdepth: 1 + + configguide/index + release-notes/index + scenarios/index + userguide/index diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..dcb7a594 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +lfdocs-conf +sphinx-opnfv-theme diff --git a/tox.ini b/tox.ini new file mode 100644 index 00000000..e038b61d --- /dev/null +++ b/tox.ini @@ -0,0 +1,20 @@ +[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 |