openstack
/
cliff
Code Issues Proposed changes

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
This commit is contained in:
Stephen Finucane 2017-07-20 15:57:39 +01:00
parent 772e16d6bb
commit 0069ccdea4
1 changed files with 0 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/user/sphinxext.rst
View File

@ -22,7 +22,6 @@ cliff supports integration with Sphinx by way of a `Sphinx directives`__.
In addition, the following directive options can be supplied: In addition, the following directive options can be supplied:
`:command:` `:command:`
The name of the command, as it would appear if called from the 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 line without the executable name. This will be defined in `setup.cfg` or
`setup.py` albeit with underscores. This is optional and `fnmatch-style`__ `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. information.
`:application:` `:application:`
The top-level application name, which will be prefixed before all The top-level application name, which will be prefixed before all
commands. This option overrides the global option commands. This option overrides the global option
`autoprogram_cliff_application` described below. `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. .. seealso:: The ``autoprogram_cliff_application`` configuration option.
`:ignored:` `:ignored:`
A comma-separated list of options to exclude from documentation for this A comma-separated list of options to exclude from documentation for this
option. This is useful for options that are of low value. 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`: placed in `conf.py`:
`autoprogram_cliff_application` `autoprogram_cliff_application`
The top-level application name, which will be prefixed before all The top-level application name, which will be prefixed before all
commands. This is generally defined in the `console_scripts` attribute of commands. This is generally defined in the `console_scripts` attribute of
the `entry_points` section of either `setup.cfg` or `setup.py`. Refer to 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. .. seealso:: The ``:application:`` directive option.
`autoprogram_cliff_ignored` `autoprogram_cliff_ignored`
A global list of options to exclude from documentation. This can be used A global list of options to exclude from documentation. This can be used
to prevent duplication of common options, such as those used for to prevent duplication of common options, such as those used for
pagination, across **all** options. pagination, across **all** options.