Commit Graph

4 Commits

Author SHA1 Message Date
Doug Hellmann 1c7f556d4f rearrange existing documentation to follow the new layout standard
This change moves existing files, updates a few of the cross-references
and paths, and fixes some formatting. It is not meant to be the final
word on how the main page looks or how the other files are organized,
but it gets everything roughly into shape. If the glance team wants to
make changes, please do those as follow-up patches

This change depends on the spec and on a feature of pbr that allows us
to move where the auto-generated class reference documentation ends up
in the tree.

Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Depends-On: I2bd5652bb59cbd9c939931ba2e7db1b37d2b30bb
Change-Id: I9dde267793a5913acb5b1ec028cfb66bc5189783
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-21 14:15:58 -04:00
Sachin Patil 50b0252a25 Corrected section underline
Section underline must be at least as long as the title text

Change-Id: I13f5398bb564c91af6c721c699a5552f2a07e561
2016-04-15 11:40:59 +05:30
Danny Al-Gaaf b9e710659f Fix link to <configuring> document
Since opts/index.rst is not on the same level as the
configuring.rst the link need to specify the correct
location.

Closes-Bug: #1556672

Change-Id: I9b9b4de130fa7c0d26f2a8ad8031afd6473ae479
Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
2016-03-14 14:14:47 +01:00
Doug Hellmann d7006d662f clean up auto-generated docs for configuration options
Split each config file out to its own page to avoid the SEVERE errors
from duplicate targets on a given page.

Use the new ability of oslo.config.sphinxext to read the existing
configuration files for the config generator to load the set of
namespaces for a given file to show all options for the service.

Change-Id: I844f43049b2b6def01541a8d761cebd0c2b0b324
Depends-On: I0ec46cc7aa820ae592d8e4e7b56ee98f0c5cbfb4
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2016-02-05 17:01:10 -05:00