From ae619be88ad8859c2b95cf1f95714f77dda53732 Mon Sep 17 00:00:00 2001 From: thmsdt Date: Mon, 20 Dec 2021 13:32:38 +0100 Subject: fix sphinx config example files and update readme Issue-ID: DOC-782 Signed-off-by: thmsdt Change-Id: I1facd195d3fddf158ebdd7deb3c8882e7db35277 --- examples/sphinx/README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) (limited to 'examples') 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 -- cgit 1.2.3-korg