This patch standardizes the CONTRIBUTING.rst file and adds the
required doc/source/contributor/contributing.rst
Change-Id: I3f7ee29094085f1abefacd75f44a16fb7e679a82
Story: #2007236
Task: #38523
Moves the Release Notes section to its own page to give it a higher
level heading to make it easier to find. Also updates info about
the Glance team's policy about the "prelude" section.
Change-Id: I31351068124e0981519ccc2e33a7bdc16f8197fd
Currently https://docs.openstack.org/glance/latest/ is a long
unorganized list of documentation links. This patch revises that
page and the 'Glance Contribution Guidelines' page to make it
easier to locate content. Also updates the main heading on other
index pages.
Change-Id: Ieea44dd05f8d164ed4c27f1205fb29b6e66d9660
Use autodoc_index_modules instead of autodoc_tree_index_modules so only
one copy of the API docs are generated.
Exclude the tests subpackage because it's not part of the Glance Python
API.
Exclude the glance.db.sqlalchemy subpackage to avoid issues caused when
parts of it cannot be imported during the doc build because they rely on
alembic setting up values that are not configured for a simple import.
Change-Id: I127b812bc879fc39533b39df1785d93835142430
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
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>