5 Commits

Author SHA1 Message Date
Nguyen Van Trung
97dbfb02d7 Add doc8 to pep8 check for glance project
This patch adds a doc8 check of .rst files to the current pep8 check.
It includes fixes to the .rst files that didn't pass the check.

Co-authored-By: Hoang Trung Hieu <hieuht@vn.fujitsu.com>
Change-Id: I5a9299200202576d97760ebf07bceb930888f2d7
2018-01-19 08:20:56 +00:00
Guoqiang Ding
4c4663bafc Update the documentation links
The documentation about "ops-guide" has been moved.

Change-Id: I9fc5ad2a3f5cd7790c6e1bc314892cac511a404d
2017-12-06 06:32:42 +00:00
Rui Yuan Dou
914bf760fb Correct sphinx syntax of glance doc
Change-Id: I0050ef32196e8ea73ef50837c27bf9e67727d1af
2017-11-03 08:56:34 +08:00
Doug Hellmann
ca7a572d11 use :ref: instead of :doc: for xref
Using :ref: makes it easier to move files around.

Change-Id: I6e5e4403f01cf78fcfe2c5f716bb59455766e652
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-21 14:15:58 -04:00
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