diff options
| author | Stephen Finucane <sfinucan@redhat.com> | 2017-07-20 15:57:39 +0100 |
|---|---|---|
| committer | Stephen Finucane <sfinucan@redhat.com> | 2017-07-20 15:57:39 +0100 |
| commit | 0069ccdea4e1245bab2d492a70445626868d6f5d (patch) | |
| tree | 08cd89476a96959b2e038e5839a9ff0d0c18699d | |
| parent | 772e16d6bbccdba4f7e43e8f4dd59d02251608b2 (diff) | |
| download | cliff-0069ccdea4e1245bab2d492a70445626868d6f5d.tar.gz | |
doc: Remove blank lines between term and definition
Definition lists should take the following format in Sphinx:
Term
Definition.
Inserting a space between the two results in a paragraph and block quote
instead of a definition list. Correct this oversight.
Change-Id: I6938c5c33257ba3c8b3a0ced9c2c5544fc209178
| -rw-r--r-- | doc/source/user/sphinxext.rst | 5 |
1 files changed, 0 insertions, 5 deletions
diff --git a/doc/source/user/sphinxext.rst b/doc/source/user/sphinxext.rst index a05ad93..eac524e 100644 --- a/doc/source/user/sphinxext.rst +++ b/doc/source/user/sphinxext.rst @@ -22,7 +22,6 @@ cliff supports integration with Sphinx by way of a `Sphinx directives`__. In addition, the following directive options can be supplied: `:command:` - The name of the command, as it would appear if called from the command line without the executable name. This will be defined in `setup.cfg` or `setup.py` albeit with underscores. This is optional and `fnmatch-style`__ @@ -30,7 +29,6 @@ cliff supports integration with Sphinx by way of a `Sphinx directives`__. information. `:application:` - The top-level application name, which will be prefixed before all commands. This option overrides the global option `autoprogram_cliff_application` described below. @@ -40,7 +38,6 @@ cliff supports integration with Sphinx by way of a `Sphinx directives`__. .. seealso:: The ``autoprogram_cliff_application`` configuration option. `:ignored:` - A comma-separated list of options to exclude from documentation for this option. This is useful for options that are of low value. @@ -50,7 +47,6 @@ cliff supports integration with Sphinx by way of a `Sphinx directives`__. placed in `conf.py`: `autoprogram_cliff_application` - The top-level application name, which will be prefixed before all commands. This is generally defined in the `console_scripts` attribute of the `entry_points` section of either `setup.cfg` or `setup.py`. Refer to @@ -68,7 +64,6 @@ cliff supports integration with Sphinx by way of a `Sphinx directives`__. .. seealso:: The ``:application:`` directive option. `autoprogram_cliff_ignored` - A global list of options to exclude from documentation. This can be used to prevent duplication of common options, such as those used for pagination, across **all** options. |