| | 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,...) |
#### 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
## 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
## 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
[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 =
[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 =
[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 =
[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
[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 =
[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 =
[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 =