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 /examples/sphinx | |
| 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
Diffstat (limited to 'examples/sphinx')
| -rw-r--r-- | examples/sphinx/README.md | 12 |
1 files changed, 10 insertions, 2 deletions
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 |