Skip to content

Commit

Permalink
Removes temporary fix for doc generation
Browse files Browse the repository at this point in the history
A temporary fix was added to get around a bug in how pbr handles
its autodoc_tree_index_modules setting. Since this bug is fixed we no
longer need the work around.

Change-Id: Id8274ef5c244bf50a34702ed9b4e50d3b82d8028
Closes-Bug: #1260495
  • Loading branch information
dstanek committed May 7, 2015
1 parent 39b7f96 commit 045e479
Show file tree
Hide file tree
Showing 4 changed files with 1 addition and 58 deletions.
Empty file removed doc/ext/__init__.py
Empty file.
48 changes: 0 additions & 48 deletions doc/ext/apidoc.py

This file was deleted.

10 changes: 0 additions & 10 deletions doc/source/conf.py
Expand Up @@ -23,12 +23,6 @@
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__),
'..', '..')))

# NOTE(blk-u): Path for our Sphinx extension, remove when
# https://launchpad.net/bugs/1260495 is fixed.
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__),
'..')))


# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
Expand All @@ -44,10 +38,6 @@
'sphinx.ext.coverage',
'sphinx.ext.intersphinx',
'oslosphinx',
# NOTE(blk-u): Uncomment the [pbr] section in setup.cfg and
# remove this Sphinx extension when
# https://launchpad.net/bugs/1260495 is fixed.
'ext.apidoc',
]

todo_include_todos = True
Expand Down
1 change: 1 addition & 0 deletions setup.cfg
Expand Up @@ -45,6 +45,7 @@ all_files = 1

[pbr]
warnerrors = True
autodoc_tree_index_modules = True

[upload_sphinx]
upload-dir = doc/build/html
Expand Down

0 comments on commit 045e479

Please sign in to comment.