openstack/openstack-helm
Code Issues Proposed changes

Reduce doc max depth

Browse Source 
Current setting the maxdepth of 3 causes all the sub-headings
(e.g. sub-titles under specs) to be displayed, needless expanding
the table of content making the doc hard to read. This patch set
reduces the maxdepth to 2 to reduce the noise in the OpenStack-Helm
documentation.

Also, this patch set touches up on RST structure and capitalization
changes in the document.

Change-Id: I7b8845f42180eafe08ed68a6c5a1e82ea49927be
Signed-off-by: Tin Lam <tin@irrational.io>
This commit is contained in:
Tin Lam 2018-01-09 18:02:08 -06:00
parent a78e638897
commit 33f115c4cc
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/index.rst
View File

@ -3,13 +3,13 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to openstack-helm's documentation!
========================================================
Welcome to OpenStack-Helm's documentation!
==========================================
Contents:
.. toctree::
:maxdepth: 3
:maxdepth: 2
contributing
devref/index
@ -20,7 +20,7 @@ Contents:
testing
troubleshooting/index
Indices and tables
Indices and Tables
==================
* :ref:`genindex`