openstack/glance
Code Issues Proposed changes

fix the autodoc instructions

Browse Source 
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>
This commit is contained in:
Doug Hellmann 2017-06-15 14:13:34 -04:00
parent 1c7f556d4f
commit a2df410e76
2 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/contributor/index.rst
View File

@ -30,7 +30,7 @@ Developer reference
database_migrations database_migrations
domain_model domain_model
domain_implementation domain_implementation
api/modules api/autoindex
Policies Policies
-------- --------

5
setup.cfg
View File

@ -85,5 +85,8 @@ mapping_file = babel.cfg
output_file = glance/locale/glance.pot output_file = glance/locale/glance.pot
[pbr] [pbr]
autodoc_tree_index_modules = True autodoc_index_modules = True
autodoc_exclude_modules =
glance.tests.*
glance.db.sqlalchemy.*
api_doc_dir = contributor/api api_doc_dir = contributor/api