From c9a39477a2deaa87393be7db8f3895a707c9a33d Mon Sep 17 00:00:00 2001 From: elinuxhenrik Date: Mon, 21 Sep 2020 10:11:08 +0200 Subject: Add documentation configuration Change-Id: I6a1bcd9829c024b5a6c6f1dd55a095a19d020028 Issue-ID: CCSDK-2833 Signed-off-by: elinuxhenrik --- .gitignore | 3 +++ docs/_static/favicon.ico | Bin 0 -> 2102 bytes docs/_static/logo_onap_2017.png | Bin 0 -> 12278 bytes docs/conf.py | 1 + docs/conf.yaml | 1 + docs/index.rst | 13 +++++++++++++ docs/requirements-docs.txt | 1 + docs/tox.ini | 22 ++++++++++++++++++++++ 8 files changed, 41 insertions(+) create mode 100755 docs/_static/favicon.ico create mode 100755 docs/_static/logo_onap_2017.png create mode 100644 docs/conf.py create mode 100644 docs/conf.yaml create mode 100644 docs/index.rst create mode 100644 docs/requirements-docs.txt create mode 100644 docs/tox.ini diff --git a/.gitignore b/.gitignore index ec003d1c..d0cca389 100644 --- a/.gitignore +++ b/.gitignore @@ -32,3 +32,6 @@ classes out/ .DS_STORE .metadata + +## Documentation ignores ## +.tox diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100755 index 00000000..cb712ebd Binary files /dev/null and b/docs/_static/favicon.ico differ diff --git a/docs/_static/logo_onap_2017.png b/docs/_static/logo_onap_2017.png new file mode 100755 index 00000000..5d064f43 Binary files /dev/null and b/docs/_static/logo_onap_2017.png differ diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..3c4453e7 --- /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 00000000..aad3f822 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1 @@ +project_cfg: onap diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..0f8726d7 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + Copyright 2020 Nordix Foundation. + + +.. _ccsdk/oran + +ccsdk/oran +---------- + +.. toctree:: + :maxdepth: 1 + + diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 00000000..74a3b7a3 --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1 @@ +lfdocs-conf diff --git a/docs/tox.ini b/docs/tox.ini new file mode 100644 index 00000000..edac8c35 --- /dev/null +++ b/docs/tox.ini @@ -0,0 +1,22 @@ +[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 -- cgit 1.2.3-korg