diff options
| author |   Jessica Wagantall <jwagantall@linuxfoundation.org> | 2020-02-06 15:26:32 -0800 |
|---|---|---|
| committer | Jessica Wagantall <jwagantall@linuxfoundation.org> | 2020-02-26 23:27:36 +0000 |
| commit | 57cf0b5c9fc3026923a98770c8ef546b9ff83ecb (patch) | |
| tree | 3a07236fe7131aee8d4fb568b7d78219fef9e11e | |
| parent | afb51f1a2acc1abc3254a72aed47cb2e86904d04 (diff) | |
Migrate policy-parent docs
Merging this will create
https://onap-policy-parent.readthedocs.io
This build will run in parallel
to the current docs generation method
until we are ready to cut over.
Issue-ID: CIMAN-364
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
Change-Id: I0c3c58710da92676bf622fb44f102a05daa8b2a0
| -rw-r--r-- | .readthedocs.yaml | 20 | ||||
| -rw-r--r-- | docs/.gitignore | 3 | ||||
| -rw-r--r-- | docs/conf.py | 15 | ||||
| -rw-r--r-- | docs/conf.yaml | 7 | ||||
| -rw-r--r-- | docs/requirements-docs.txt | 15 | ||||
| -rw-r--r-- | docs/tox.ini | 22 |
6 files changed, 82 insertions, 0 deletions
diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..3797dc8b --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,20 @@ +--- +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details +# Required +version: 2 + +formats: + - htmlzip + +build: + image: latest + +python: + version: 3.7 + install: + - requirements: docs/requirements-docs.txt + +sphinx: + configuration: docs/conf.py diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..43ca5b67 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,3 @@ +/.tox +/_build/* +/__pycache__/* diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..526ec693 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,15 @@ +from docs_conf.conf import * + +branch = 'latest' +master_doc = 'index' + +linkcheck_ignore = [ + 'http://localhost', +] + +intersphinx_mapping = {} + +html_last_updated_fmt = '%d-%b-%y %H:%M' + +def setup(app): + app.add_stylesheet("css/ribbon_onap.css")
\ No newline at end of file diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 00000000..ab592813 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,7 @@ +--- +project_cfg: onap +project: onap + +# Change this to ReleaseBranchName to modify the header +default-version: latest +# diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 00000000..b3188ddd --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1,15 @@ +tox +Sphinx +doc8 +docutils +setuptools +six +sphinx_rtd_theme>=0.4.3 +sphinxcontrib-blockdiag +sphinxcontrib-needs>=0.2.3 +sphinxcontrib-nwdiag +sphinxcontrib-seqdiag +sphinxcontrib-swaggerdoc +sphinxcontrib-plantuml +sphinx_bootstrap_theme +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 |