Use oslo.config sphinx extension "sphinxconfiggen" to generate sample
configuration files at the beginning of each sphinx build. Include the
generated sample configuration files as part of the developer docs so
that they can be removed from the code tree eventually.
Change-Id: I42934a437272b3822efd84bfe16392341804baed
Co-Authored-By: Nikhil Komawar <nik.komawar@gmail.com>
Co-Authored-By: Hemanth Makkapati <hemanth.makkapati@rackspace.com>
When building packages if git is absent, then we should not set
html_last_updated_fmt. It can still be set via the -D switch
when building with sphinx-build.
Change-Id: I6fe2d0aa049d72b7e1c6af19a7326f9f75742b66
Closes-Bug: #1552251
It looks like in the docs config.py there
needs to be some modifications so the module
docs can be generated through sphinx
Change-Id: I41a2d62a2300100d9fb412698360bb1238cf7406
Closes-Bug: #1552830
Use oslo_config.sphinxext to automatically document the available
configuration options in the sphinx documentation.
See https://etherpad.openstack.org/p/automating-oslo-config-documentation
for work to implement this to each project. Glance is one of the first
six projects for a consolidated operators configuration reference.
Change-Id: If701f7dfa240075457e6e149bcb12ff713a8c79b
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.
Change-Id: I044e88e82bcaff14fe57e876dd59d48197cd68be
Partial-Bug: #1529836
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)
This also removes the requirement for internet access during docs build.
This causes docs jobs to fail because we error out on warnings.
Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
Finish updating the glance manpages:
- Update and modernize all files and references
- Add a new manpage for glance-replicator
- Move the common configuration options to common files for
easier maintenance and less redundancy
Change-Id: If2cbcc30f2761b187038f39324c7698de4eb2ab9
Closes-Bug: #1238366
Use the new oslo.sphinx version of the OpenStack doc
theme instead of copying it into this repo.
blueprint oslo.sphinx
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
Change-Id: I0bd91f7bb43f97b99051fed65b75fc05d5149cc8
The executable programs used by Glance have historically been scripts
in the ./bin directory. This patch converts all of the scripts to
entry_points. This change makes these programs python modules. Thus
they can be imported and methods in them can be called just like any
other module. This will allow the tests to call into these programs
directly instead of having to fork out a process.
The conf.py file in the doc tree was causing a name collision with
the python module cmd. The glance/glance directory was being added
to sys.path which made glance.cmd import with the name cmd. This
patch also fixes that problem.
blueprint: refactoring-better-faster-stronger-functional-tests
Change-Id: I67ae14b7403af31a5944befcd2ec27a690e81f15
Patchset addresses reviewer's comments, rebase against master,
and follows new guidance from Foundation:
http://wiki.openstack.org/Documentation/Copyright
Change-Id: I94367461505778973528eb8835d991f4fb796dab
* Remove autodoc sphinx extension
* Ignore auto-generated 'api' docs
* Prevent the corresponding 'api' index from being created
* Prevent an empty 'index' page from getting generated
Related to bp glance-folsom-docs-cleanup
Change-Id: I82c9389f884ea4af853f1215731c051d1fb596e8
* bin/glance-cache-queue-image duplicates functionality provided by
bin/ glance-cache-manage, and it is currently broken. Let's just remove it.
Change-Id: Ib18be2116055154047df6ca9b4c335323c8b2dde
A few man pages were already in place. This patch uses the --help
output from each executable to seed a man page for the rest of the
executables, which include:
- glance
- glance-cache-cleaner
- glance-cache-manage
- glance-cache-prefetcher
- glance-cache-pruner
- glance-cache-queue-image
- glance-control
- glance-scrubber
Fixes bug 911291.
Change-Id: Ie0de990ff6617e7eb953f270a089c99bc340b4fe
Currently the wrong directory is searched for the
glance module, requiring glance to be installed
in the default system path, for docs to be buildable.
Also the path was appended, so the default system version
which may be completely different is referenced.
This ensures that only local glance files are referenced.
Change-Id: Ia226c90bbd24d7804401a7c9e444387c78a0f542
