diff options
| author |   Trevor Bramwell <tbramwell@linuxfoundation.org> | 2018-08-30 18:51:37 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@opnfv.org> | 2018-08-30 18:51:37 +0000 |
| commit | c1090621dbe5d54b8d52cfe380213bc152b3f7c5 (patch) | |
| tree | bfa8bc075091d877df1a3f129862d1ce34049229 /docs/how-to-use-docs/files | |
| parent | 8165c1bdfef15ce62dcfe54ecd4698bb1725c41d (diff) | |
| parent | 8f28a9846b2ec7470004f3203a1d3b380855726e (diff) | |
Merge "Submodule to RTD transition documentation"
Diffstat (limited to 'docs/how-to-use-docs/files')
| -rw-r--r-- | docs/how-to-use-docs/files/conf.py | 1 | ||||
| -rw-r--r-- | docs/how-to-use-docs/files/conf.yaml | 3 | ||||
| -rw-r--r-- | docs/how-to-use-docs/files/index | 17 | ||||
| -rw-r--r-- | docs/how-to-use-docs/files/requirements.txt | 5 | ||||
| -rw-r--r-- | docs/how-to-use-docs/files/tox.ini | 17 |
5 files changed, 43 insertions, 0 deletions
diff --git a/docs/how-to-use-docs/files/conf.py b/docs/how-to-use-docs/files/conf.py new file mode 100644 index 000000000..3c4453e71 --- /dev/null +++ b/docs/how-to-use-docs/files/conf.py @@ -0,0 +1 @@ +from docs_conf.conf import * diff --git a/docs/how-to-use-docs/files/conf.yaml b/docs/how-to-use-docs/files/conf.yaml new file mode 100644 index 000000000..caad28ff4 --- /dev/null +++ b/docs/how-to-use-docs/files/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: Example diff --git a/docs/how-to-use-docs/files/index b/docs/how-to-use-docs/files/index new file mode 100644 index 000000000..21da2ac4e --- /dev/null +++ b/docs/how-to-use-docs/files/index @@ -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 + +.. _opnfv-project-foo: + +=== +FOO +=== + +.. toctree:: + :numbered: + :maxdepth: 2 + + development + release + testing diff --git a/docs/how-to-use-docs/files/requirements.txt b/docs/how-to-use-docs/files/requirements.txt new file mode 100644 index 000000000..440843584 --- /dev/null +++ b/docs/how-to-use-docs/files/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 diff --git a/docs/how-to-use-docs/files/tox.ini b/docs/how-to-use-docs/files/tox.ini new file mode 100644 index 000000000..69aa18937 --- /dev/null +++ b/docs/how-to-use-docs/files/tox.ini @@ -0,0 +1,17 @@ +[tox] +minversion = 1.6 +envlist = + docs, + docs-linkcheck +skipsdist = true + +[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 |