policy sample file with all the default rules
commented out is missing in glance doc which can be
used for reference or when few rules needs to
be overriden (and keep all other default rule commented
out).
Change-Id: I0cc461f7061358389186ac4751f6e037e1bf6dc7
Including removal of the example conf in docs.
Including glance-registry command entrypoint to eventlet.
Including rpc_controller from wsgi, changed to reject.
Not including the files devstack is depending on.
This change means that glance-registry starts and announces
that it has been removed.
This change means that when ran as wsgi app, all calls to
/rpc endpoint will be rejected.
This will allow devstack to make a graceful transition to
life without the glance registry, which was deprecated in
Newton release.
Change-Id: I7bf3284cba4c38605fb50b3c458e53f896f34086
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Disable openstackdocs_auto_name to use 'project' variable as name.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: Ib1796ac0c786c16bade68668f0d978ee71d29307
Update to hacking 3.0.
Enable local hacking checks again, newer flake has a different
interface.
Remove hacking and friends from lower-constraints, they are not needed
for installation.
Unbreak docs:
Don't build apidocs for hacking - blacklist in doc/source/conf.py.
Change-Id: Ib230d72be9f0288d77cecd2c5ee0ff7aa91fc086
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Update requirements: Remove sphinx, it's not needed for testing, add
pygments which is really needed.
- Update doc/requirements: Remove python 2.7 support
- tox.ini: Remove testing of po files, the infra scripts do this since
a long time
- Update conf.py, no need to import openstackdocstheme anymore.
Change-Id: I9d030eb450f2c7ae74c25b7564a01b8785503e5e
This reverts commit 2a28696de9.
Devstack still references a number of these files; revert until
devstack incorporates removal.
Change-Id: I1e90ceee1f87291668e447f180f37bb809763836
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
Change-Id: Ica74f2982a75e3faf7a5244390f2299381eb5b89
Follow docs[1] and update the sphinx theme configuration,
Also updated bug_tag values for api-ref and documentation.
[1] https://docs.openstack.org/openstackdocstheme/latest/
Co-authored-by: wanghui <wang_hui@inspur.com>
Closes-bug: #1768365
Change-Id: I76308497122f4522fe307b3c29b696780e073027
Adds .htaccess containing redirects so old URLs can retrieve
the correct document from the docs reorganization introduced
with commit 1c7f556d4f.
Change-Id: I9678eedd5634ac04482f3f8b5ee0e4177cf985e3
Needed-by: https://review.openstack.org/564344
Partial-bug: #1766257
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>
Fix the Sphinx html_last_updated_fmt for Python3.
The html_last_updated_fmt option is interpeted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
Change-Id: I2d79405579e55ae77c8f8e353a15c49474061e1e
Partially reverts I6d67e7a40e16468bb7bf4ac742361fb44eec4e28 to
restore the source files for the man pages. These are used by
some packagers (confirmed that this is the case for Ubuntu) to
generate the man pages included in their distributions.
Does not add the man pages back to the HTML index, so these will
be orphans for now. A follow up patch will either add a man build
to tox, or add the HTML generation back so we can review generated
content.
Long term fix will be to merge the content of the --help text
in the cmd files with the content of the man pages and figure
out how to generate the man pages from the --help text. Right
now, the --help text is better in some regards, and the man pages
are better in others.
Change-Id: I2aa85b63a196c75224630981b322fecbf36f1b7c
Glare became a separate project during Newton. The code was copied
out of the Glance tree, but remained in the Glance repository. It
is no longer being maintained, and that has begun to cause some
problems, for example, blocking a recent stevedore upper constraints
change; see I141b17f9dd2acebe2b23f8fc93206e23bc70b568
This patch removes the Glare code from the Glance repository. It
includes Alembic database migration scripts, in both the all-in-one
and E-M-C format. It also includes release notes.
Implements: blueprint glare-ectomy
Change-Id: I3026ca6287a65ab5287bf3843f2a9d756ce15139
1. Deletes man pages
2. Deletes indices section
3. Moves the contributor section up to the top
Change-Id: I6d67e7a40e16468bb7bf4ac742361fb44eec4e28
Implements: blueprint overhaul-glance-docs
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
xuanyandong