diff options
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | docs/conf.py | 4 | ||||
| -rw-r--r-- | docs/conf.yaml | 1 | ||||
| -rw-r--r-- | docs/requirements-docs.txt | 1 | ||||
| -rw-r--r-- | docs/tox.ini | 22 | ||||
| -rw-r--r-- | tox.ini | 32 |
6 files changed, 39 insertions, 23 deletions
@@ -10,6 +10,7 @@ org.eclipse.core.resources.prefs .checkstyle maven-eclipse.xml workspace +.pydevproject ## Compilation Files ## *.class @@ -35,3 +36,4 @@ out/ ## Documentation ignores ## .tox +_build/ diff --git a/docs/conf.py b/docs/conf.py index 3c4453e7..0339628f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1 +1,5 @@ from docs_conf.conf import * + +#branch configuration + +branch = 'latest' diff --git a/docs/conf.yaml b/docs/conf.yaml index aad3f822..5b6d55fe 100644 --- a/docs/conf.yaml +++ b/docs/conf.yaml @@ -1 +1,2 @@ project_cfg: onap +project: onap
\ No newline at end of file diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt deleted file mode 100644 index 74a3b7a3..00000000 --- a/docs/requirements-docs.txt +++ /dev/null @@ -1 +0,0 @@ -lfdocs-conf diff --git a/docs/tox.ini b/docs/tox.ini deleted file mode 100644 index edac8c35..00000000 --- a/docs/tox.ini +++ /dev/null @@ -1,22 +0,0 @@ -[tox] -minversion = 1.6 -envlist = docs, -skipsdist = true - -[testenv:docs] -basepython = python3 -deps = -r{toxinidir}/requirements-docs.txt -commands = - sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html - echo "Generated docs available in {toxinidir}/_build/html" -whitelist_externals = - echo - git - sh - -[testenv:docs-linkcheck] -basepython = python3 -#deps = -r{toxinidir}/requirements-docs.txt -commands = echo "Link Checking not enforced" -#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck -whitelist_externals = echo diff --git a/tox.ini b/tox.ini new file mode 100644 index 00000000..32de8a6c --- /dev/null +++ b/tox.ini @@ -0,0 +1,32 @@ +[tox] +minversion = 2.0 +envlist = docs, +skipsdist = true + +[testenv:docs] +basepython = python3 +deps = + sphinx + sphinx-rtd-theme + sphinxcontrib-httpdomain + sphinxcontrib.blockdiag + sphinxcontrib.needs + sphinxcontrib.plantuml + sphinxcontrib.nwdiag + sphinxcontrib.seqdiag + sphinxcontrib.swaggerdoc + recommonmark + lfdocs-conf +commands = + sphinx-build -b html -n -d {envtmpdir}/docs/doctrees ./docs/ {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +whitelist_externals = + echo + git + sh + +[testenv:docs-linkcheck] +basepython = python3 +commands = echo "Link Checking not enforced" +#commands = sphinx-build -b linkcheck -d {envtmpdir}/docs/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck +whitelist_externals = echo |