From acd34d7c138f1764ccc90088d9e1f0b51aa0ed60 Mon Sep 17 00:00:00 2001 From: thmsdt Date: Mon, 18 Jul 2022 14:51:16 +0200 Subject: update sphinx example configuraton Issue-ID: DOC-798 Signed-off-by: thmsdt Change-Id: Ie3032dbaf531e2de1ee144a946a3e4f51fc04f9a --- examples/sphinx/README.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) (limited to 'examples/sphinx/README.md') diff --git a/examples/sphinx/README.md b/examples/sphinx/README.md index 616961e50..ec94cd0b1 100644 --- a/examples/sphinx/README.md +++ b/examples/sphinx/README.md @@ -27,16 +27,6 @@ https://docs.releng.linuxfoundation.org/projects/lfdocs-conf/en/latest/config.ht 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 - --- ## requirements-docs.txt ##### DESCRIPTION: @@ -49,6 +39,7 @@ Contains the required libraries to be used by Sphinx. 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: @@ -56,4 +47,9 @@ 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 +https://tox.wiki/en/latest/config.html + +--- +## index.rst +##### DESCRIPTION: +The reStructuredText Cheat Sheet as an example .rst file -- cgit 1.2.3-korg