diff options
| author |   thmsdt <thomas.kulik@telekom.de> | 2021-12-20 13:32:38 +0100 |
|---|---|---|
| committer | thmsdt <thomas.kulik@telekom.de> | 2021-12-20 14:42:05 +0100 |
| commit | ae619be88ad8859c2b95cf1f95714f77dda53732 (patch) | |
| tree | c9fa58c0f9c4f1851bc49ae63b7d0da937d26f51 | |
| parent | ce97ac55ec9bdcec212d1f399442e35d8ccdd82e (diff) | |
fix sphinx config example files and update readme
Issue-ID: DOC-782
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: I1facd195d3fddf158ebdd7deb3c8882e7db35277
| -rw-r--r-- | .readthedocs.yaml | 2 | ||||
| -rw-r--r-- | docs/index.rst | 4 | ||||
| -rw-r--r-- | etc/requirements-docs.txt (renamed from etc/requirements.txt) | 0 | ||||
| -rw-r--r-- | examples/sphinx/README.md | 12 | ||||
| -rw-r--r-- | tox.ini | 14 |
5 files changed, 20 insertions, 12 deletions
diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 10453a93d..9972e7212 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,7 +12,7 @@ build: python: version: 3.7 install: - - requirements: etc/requirements.txt + - requirements: etc/requirements-docs.txt submodules: include: all diff --git a/docs/index.rst b/docs/index.rst index e65a7864c..f7cfd7b96 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -37,8 +37,8 @@ Please find some guidance here on the content of ONAP documentation: | | Common services and the ONAP Portal support the certain functions. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`ONAP Components and Functionalities <doc_onap-developer_guide_projects>` | The ONAP Components and Functionalities are described in details here. | - | | We can learn what functionalities ONAP provides and how the certain components in ONAP | - | | operate together. | + | | We can learn what functionalities ONAP provides and how the certain components in | + | | ONAP operate together. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`Operations and Adminstration Guides <operation_guides>` | ONAP Platform operation and adminstration cover the configuration and installation of ONAP, | | | its management, monitoring and other operational tasks (integration, user management,...) | diff --git a/etc/requirements.txt b/etc/requirements-docs.txt index b6654e56c..b6654e56c 100644 --- a/etc/requirements.txt +++ b/etc/requirements-docs.txt diff --git a/examples/sphinx/README.md b/examples/sphinx/README.md index 9d416c889..616961e50 100644 --- a/examples/sphinx/README.md +++ b/examples/sphinx/README.md @@ -19,6 +19,8 @@ directory you can execute the '*tox -e docs*' command and the build starts. #### DESCRIPTION: The “build configuration file” contains (almost) all configuration needed to customize Sphinx input and output behavior. +#### PATH: +{project}/docs/conf.py #### SEE ALSO: https://docs.releng.linuxfoundation.org/projects/lfdocs-conf/en/latest/config.html @@ -29,6 +31,8 @@ https://www.sphinx-doc.org/en/master/usage/configuration.html ## conf.yaml #### DESCRIPTION: Required to customize lfdocs-conf behavior. +#### PATH: +{project}/docs/conf.yaml ##### SEE ALSO: https://docs.releng.linuxfoundation.org/projects/lfdocs-conf/en/latest/config.html @@ -37,15 +41,19 @@ https://docs.releng.linuxfoundation.org/projects/lfdocs-conf/en/latest/config.ht ## requirements-docs.txt ##### DESCRIPTION: Contains the required libraries to be used by Sphinx. - +#### PATH: +{project}/etc/requirements-docs.txt --- ## .readthedocs.yaml ##### DESCRIPTION: Required to customize the ReadTheDocs input and output behavior. **Important:** This file is located in your {project} root directory (e.g. *doc/.readthedocs.yaml*). - +#### PATH: +{project}/.readthedocs.yaml --- ## tox.ini ##### DESCRIPTION: Required to customize different tox environments. +#### PATH: +{project}/tox.ini ##### SEE ALSO: https://tox.wiki/en/latest/config.html
\ No newline at end of file @@ -6,7 +6,7 @@ skipsdist = true [testenv:docs] basepython = python3 deps = - -r{toxinidir}/etc/requirements.txt + -r{toxinidir}/etc/requirements-docs.txt -c{toxinidir}/etc/upper-constraints.os.txt -c{toxinidir}/etc/upper-constraints.onap.txt commands = @@ -20,7 +20,7 @@ whitelist_externals = [testenv:docs-templates] basepython = python3 deps = - -r{toxinidir}/etc/requirements.txt + -r{toxinidir}/etc/requirements-docs.txt -c{toxinidir}/etc/upper-constraints.os.txt -c{toxinidir}/etc/upper-constraints.onap.txt commands = @@ -32,7 +32,7 @@ whitelist_externals = [testenv:local] basepython = python3 deps = - -r{toxinidir}/etc/requirements.txt + -r{toxinidir}/etc/requirements-docs.txt -c{toxinidir}/etc/upper-constraints.os.txt -c{toxinidir}/etc/upper-constraints.onap.txt commands = @@ -46,7 +46,7 @@ whitelist_externals = [testenv:docs-linkcheck] basepython = python3 deps = - -r{toxinidir}/etc/requirements.txt + -r{toxinidir}/etc/requirements-docs.txt -c{toxinidir}/etc/upper-constraints.os.txt -c{toxinidir}/etc/upper-constraints.onap.txt commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck @@ -54,7 +54,7 @@ commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinid [testenv:spellcheck] basepython = python3 deps = - -r{toxinidir}/etc/requirements.txt + -r{toxinidir}/etc/requirements-docs.txt -c{toxinidir}/etc/upper-constraints.os.txt -c{toxinidir}/etc/upper-constraints.onap.txt commands = @@ -62,7 +62,7 @@ commands = [testenv:autopep8] deps = - -r{toxinidir}/etc/requirements.txt + -r{toxinidir}/etc/requirements-docs.txt -c{toxinidir}/etc/upper-constraints.os.txt -c{toxinidir}/etc/upper-constraints.onap.txt commands = @@ -70,7 +70,7 @@ commands = [testenv:pylint] deps = - -r{toxinidir}/etc/requirements.txt + -r{toxinidir}/etc/requirements-docs.txt -c{toxinidir}/etc/upper-constraints.os.txt -c{toxinidir}/etc/upper-constraints.onap.txt commands = |