diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-05 16:20:58 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-05 16:20:58 +0000 |
| commit | ffcb4b87846b4e4a2d9eee8df4b7ec40365878b8 (patch) | |
| tree | 3c64877dd20ad1141111c77b3463e95686002b39 /doc/usage/extensions/napoleon.rst | |
| parent | Adding debian version 7.2.6-8. (diff) | |
| download | sphinx-ffcb4b87846b4e4a2d9eee8df4b7ec40365878b8.tar.xz sphinx-ffcb4b87846b4e4a2d9eee8df4b7ec40365878b8.zip | |
Merging upstream version 7.3.7.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/usage/extensions/napoleon.rst')
| -rw-r--r-- | doc/usage/extensions/napoleon.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/usage/extensions/napoleon.rst b/doc/usage/extensions/napoleon.rst index d2391da..4b077de 100644 --- a/doc/usage/extensions/napoleon.rst +++ b/doc/usage/extensions/napoleon.rst @@ -63,14 +63,14 @@ Getting Started ~~~~~~~~~~~~~~~ 1. After :doc:`setting up Sphinx </usage/quickstart>` to build your docs, - enable napoleon in the Sphinx `conf.py` file:: + enable napoleon in the Sphinx ``conf.py`` file:: # conf.py # Add napoleon to the extensions list extensions = ['sphinx.ext.napoleon'] -2. Use `sphinx-apidoc` to build your API documentation:: +2. Use ``sphinx-apidoc`` to build your API documentation:: $ sphinx-apidoc -f -o docs/source projectdir @@ -271,8 +271,8 @@ Configuration ------------- Listed below are all the settings used by napoleon and their default -values. These settings can be changed in the Sphinx `conf.py` file. Make -sure that "sphinx.ext.napoleon" is enabled in `conf.py`:: +values. These settings can be changed in the Sphinx ``conf.py`` file. Make +sure that "sphinx.ext.napoleon" is enabled in ``conf.py``:: # conf.py |