openstack/glance_store
Code Issues Proposed changes

Fix doc generation warnings and errors

Browse Source 
When docs are generated with pbr command 'warnerrors = True'
there are many doc problems that are shown. This patch fixes
these problems.

Closes-Bug: #1557234
Change-Id: I05f2f96a582e44be28ab73e0bb80294facf902d5
This commit is contained in:
Tom Cocozzello
2016-03-14 19:32:00 -05:00
parent 5c6c6e6f4c
commit 1ce1f40f5a
3 changed files with 26 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/conf.py
View File

@@ -44,7 +44,7 @@ pygments_style = 'sphinx'
# Sphinx are currently 'default' and 'sphinxdoc'. # Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."] # html_theme_path = ["."]
# html_theme = '_theme' # html_theme = '_theme'
html_static_path = ['static'] # html_static_path = ['static']
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project htmlhelp_basename = '%sdoc' % project

21
doc/source/index.rst
View File

@@ -10,8 +10,11 @@ glance_store Manual Pages
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
Module Hierarchy <api/modules>
* :ref:`modindex` * :ref:`modindex`
Store Drivers Store Drivers
============= =============
@@ -61,7 +64,7 @@ Release Notes
* Dropped py26 support * Dropped py26 support
* Disable propagating BadStoreConfiguration * Disable propagating BadStoreConfiguration
* _1454695: Sync with global-requirements * 1454695_: Sync with global-requirements
* Handle optional dependency in vmware store * Handle optional dependency in vmware store
.. _1454695: https://bugs.launchpad.net/glance-store/+bug/1454695 .. _1454695: https://bugs.launchpad.net/glance-store/+bug/1454695
@@ -69,10 +72,10 @@ Release Notes
0.5.0 0.5.0
----- -----
* _1449639: Fix failure when creating an image which already exists in the RBD store * 1449639_: Fix failure when creating an image which already exists in the RBD store
* _1444663: Correctly instantiate Forbidden exception * 1444663_: Correctly instantiate Forbidden exception
* _1428257: Do not raise an exception when a duplicate path on filesystem store is used. Instead emmit a warning * 1428257_: Do not raise an exception when a duplicate path on filesystem store is used. Instead emmit a warning
* _1422699: Propagate BadStoreConfiguration to library user * 1422699_: Propagate BadStoreConfiguration to library user
* Initialize vmware session during store creation * Initialize vmware session during store creation
.. _1449639: https://bugs.launchpad.net/glance-store/+bug/1449639 .. _1449639: https://bugs.launchpad.net/glance-store/+bug/1449639
@@ -84,9 +87,9 @@ Release Notes
----- -----
* Deprecate the gridfs store * Deprecate the gridfs store
* Use oslo_config.cfg.ConfigOpts in glance_store * Use oslo_config.cfg.ConfigOpts in glance_store
* _1426767: Make dependency on boto entirely conditional * 1426767_: Make dependency on boto entirely conditional
* _1429785: Fix timeout during upload from slow resource * 1429785_: Fix timeout during upload from slow resource
* _1418396: Throw NotFound exception when template is gone * 1418396_: Throw NotFound exception when template is gone
* Correct such logic in store.get() when chunk_size param provided * Correct such logic in store.get() when chunk_size param provided
.. _1426767: https://bugs.launchpad.net/glance-store/+bug/1426767 .. _1426767: https://bugs.launchpad.net/glance-store/+bug/1426767
@@ -119,7 +122,7 @@ Release Notes
* Convert httpretty tests to requests-mock * Convert httpretty tests to requests-mock
0.1.11 0.1.11
------- ------
* 1402354_: Check VMware session before uploading image * 1402354_: Check VMware session before uploading image
* Add capabilities to storage driver * Add capabilities to storage driver

1
setup.cfg
View File

@@ -74,6 +74,7 @@ all_files = 1
[pbr] [pbr]
autodoc_tree_index_modules = True autodoc_tree_index_modules = True
warnerrors = True
[upload_sphinx] [upload_sphinx]
upload-dir = doc/build/html upload-dir = doc/build/html