openstack
/
cliff
Code Issues Proposed changes

doc: minor cleanup 

* We have a long index in user/index page, as the history page
  has a lot of sections. It loses the readability in general.
  Let's use maxdepth 1 for history in the toctree directive.

* Remove unnecessary vertical line for quote blocks.
  openstackdocstheme shows a vertial line for quote blocks.
  If we have unnecessary leading spaces, the vertical line are shown.
  This cleans up such spaces in user/sphinxext.rst.

Change-Id: I913d23cc6148d37d28c27c4f3a40b5a6225dac76
This commit is contained in:
Akihiro Motoki 2017-07-12 23:50:17 +00:00
parent d025ad9cd3
commit eec65e3dfe
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -12,4 +12,9 @@
complete
interactive_mode
sphinxext
.. history contains a lot of sections, toctree with maxdepth 1 is used.
.. toctree::
:maxdepth: 1
history

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:
`: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.