Improve doc formatting a bit
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
This commit is contained in:
parent
a134c10ea4
commit
262061afd0
@ -17,6 +17,8 @@ library, and adding logic and features that the OpenStack Infra team had
|
|||||||
developed to run client applications at scale, it turned out that we'd written
|
developed to run client applications at scale, it turned out that we'd written
|
||||||
nine-tenths of what we'd need to have a standalone library.
|
nine-tenths of what we'd need to have a standalone library.
|
||||||
|
|
||||||
|
.. _example:
|
||||||
|
|
||||||
Example
|
Example
|
||||||
=======
|
=======
|
||||||
|
|
||||||
|
@ -3,6 +3,7 @@
|
|||||||
You can adapt this file completely to your liking, but it should at least
|
You can adapt this file completely to your liking, but it should at least
|
||||||
contain the root `toctree` directive.
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
|
=================================
|
||||||
Welcome to shade's documentation!
|
Welcome to shade's documentation!
|
||||||
=================================
|
=================================
|
||||||
|
|
||||||
@ -14,6 +15,11 @@ Contents:
|
|||||||
install/index
|
install/index
|
||||||
user/index
|
user/index
|
||||||
contributor/index
|
contributor/index
|
||||||
|
|
||||||
|
.. releasenotes contains a lot of sections, toctree with maxdepth 1 is used.
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
releasenotes/index
|
releasenotes/index
|
||||||
|
|
||||||
.. include:: ../../README.rst
|
.. include:: ../../README.rst
|
||||||
|
@ -6,6 +6,8 @@ To use shade in a project::
|
|||||||
|
|
||||||
import shade
|
import shade
|
||||||
|
|
||||||
|
For a simple example, see :ref:`example`.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
API methods that return a description of an OpenStack resource (e.g.,
|
API methods that return a description of an OpenStack resource (e.g.,
|
||||||
server instance, image, volume, etc.) do so using a `munch.Munch` object
|
server instance, image, volume, etc.) do so using a `munch.Munch` object
|
||||||
|
Loading…
Reference in New Issue
Block a user