The castellan user interface library recently
deprecated the 'api_class' configuration option
in favor of the 'backend' configuration option.
This change updates the image signature
verification documentation to use the new
configuration option.
Change-Id: I0cc115eed1b7f271fe4bb7d0a385d487f2494d73
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
Updates scrubber docs to take into account the refactoring done in
change I26f570b85617200880543b7114730a1ac76d3fb1 and updates the
header info for all cli docs in anticipation of the Queens release.
Change-Id: I61095b9ba8f7e12fcf2005aa6f8af501829dfa6b
Issue was raised in I20171c815d4718bb90f54b5b4184191118f31fe2 that the link
to the SQLAlchemy reference doc was not correct, but that is outside the
scope for what that patch is addressing.
To address that concern, this changes the link to the current URL.
TrivialFix
Change-Id: I43aac003805d0496cb7b906af9b24b92335b9dfa
There have been some lessons learned on how to best deploy glance from
using uwsgi in the gate. This commit updates the docs a bit to explain
some pitfalls to avoid.
This also adds a glossary at th end of the docs to explain common terms.
There are several very similar terms with related meanings used in the doc
so to clear up confusing the glossary should be helpful.
Change-Id: I255d2049a5d519909c88101833ddd259328fcee7
Add a description of the new URL format for project documentation.
We've been getting a bunch of patches to modify URLs and it's hard
to know which ones are the canonical format since there are redirects
so that both the old and new URLs currently work.
Change-Id: I84136af8315f3421f7d7825fdb7d096f019a6e08
In Queens, we've begun putting lite specs into their own
individual files instead of all combined into a single file.
This patch changes the contributor docs to reflect this.
Depends-on: I85b096fc0c99a70e3ad0d7f8727b7d5ab679c95b
Change-Id: I94bc4cb3d73d22b06aa923dd29c64208da6a3477
1. Using the relative pointer to the resource on latest version, and this
can avoid the manually change on every release.
2. Pretty format the json data.
Change-Id: I5eb5c156f3f730c2c51dc5d917e591a28c059282
The indentation of glance database creation was incorrect.
This patch fixes it.
Change-Id: If3ca607258363f5b6e8e1b86e0425fd74da2e62a
Closes-Bug: #1718125
The db.rst file had two top level headings and the second wasn't
being rendered in the html pages. Separated the zero downtime
section into its own section to fix this and made a few updates
to the text.
Change-Id: I913326653642d8f19173f18868d4e8cbb89a5b77
A recent release of pbr explicitly requires stating which builders are
requested, rather than defaulting to html and man. This has resulted in
man pages not being built. Correct this oversight, along with a few
issues that have been introduced to 'doc/source/conf.py' since. It is
also necessary to remove a couple of plugins as there seems to be
another pbr bug under the hood. Fortunately none of these are used so
it's all good.
Change-Id: I22fd4d113704949dbf7704f50fa1d08fa10f11b6
Set some of the new config values and enable openstackdocstheme as an
extension so it will inject values into the page context as it writes
each documentation page. This ensures the pages link to the right bug
tracker, etc.
Change-Id: I3e8d3a68aaa5da3318b2b253e8db982d64e4b1b6
Depends-On: Icf3a40ed104cfd828f532f6f2b112ed02f996ff5
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Using :ref: makes it easier to move files around.
Change-Id: I6e5e4403f01cf78fcfe2c5f716bb59455766e652
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
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>
