262061afd0
After migrating to openstackdocstheme, some shade document became not easy to read. This commit fixes them a bit. - openstackdocstheme assumee only one title per page. Use a different level of title for the title. Otherwise, titles with the same level are not shown. - Release notes page has a lot of sections. It leads to a long TOC in the user guide index page. Use maxdepth=1 explicitly for the release notes. - Add a link to a simple example to usage.rst. It helps users who access the user guide directly. Change-Id: If51afa471505296b502bed3288cc9bcf30a69ba3
32 lines
647 B
ReStructuredText
32 lines
647 B
ReStructuredText
.. shade documentation master file, created by
|
|
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
=================================
|
|
Welcome to shade's documentation!
|
|
=================================
|
|
|
|
Contents:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
install/index
|
|
user/index
|
|
contributor/index
|
|
|
|
.. releasenotes contains a lot of sections, toctree with maxdepth 1 is used.
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
releasenotes/index
|
|
|
|
.. include:: ../../README.rst
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`search`
|