diff options
| author |   thmsdt <thomas.kulik@telekom.de> | 2022-07-18 14:51:16 +0200 |
|---|---|---|
| committer | thmsdt <thomas.kulik@telekom.de> | 2022-07-18 14:52:27 +0200 |
| commit | acd34d7c138f1764ccc90088d9e1f0b51aa0ed60 (patch) | |
| tree | ecd35f8dd602e9ee57b7ceadb9c274e9b910478d /examples/sphinx/README.md | |
| parent | 40d8518bad5d3870ee3bcb579e9ba757df612a35 (diff) | |
update sphinx example configuraton
Issue-ID: DOC-798
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: Ie3032dbaf531e2de1ee144a946a3e4f51fc04f9a
Diffstat (limited to 'examples/sphinx/README.md')
| -rw-r--r-- | examples/sphinx/README.md | 18 |
1 files changed, 7 insertions, 11 deletions
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 @@ -28,16 +28,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: Contains the required libraries to be used by Sphinx. @@ -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 |