Removes temporary fix for doc generation

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
(cherry picked from commit 045e47938f445741b6efedeb7243d3b413ea3229)

doc/ext/apidoc.py

@@ -1,46 +0,0 @@
-# Copyright 2014 OpenStack Foundation
-#
-# Licensed under the Apache License, Version 2.0 (the "License"); you may
-# not use this file except in compliance with the License. You may obtain
-# a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-# License for the specific language governing permissions and limitations
-# under the License.
-
-# NOTE(blk-u): Uncomment the [pbr] section in setup.cfg and remove this
-# Sphinx extension when https://launchpad.net/bugs/1260495 is fixed.
-
-import os.path as path
-
-from sphinx import apidoc
-
-
-# NOTE(blk-u): pbr will run Sphinx multiple times when it generates
-# documentation. Once for each builder. To run this extension we use the
-# 'builder-inited' hook that fires at the beginning of a Sphinx build.
-# We use ``run_already`` to make sure apidocs are only generated once
-# even if Sphinx is run multiple times.
-run_already = False
-
-
-def run_apidoc(app):
-    global run_already
-    if run_already:
-        return
-    run_already = True
-
-    package_dir = path.abspath(path.join(app.srcdir, '..', '..',
-                                         'keystoneauth'))
-    source_dir = path.join(app.srcdir, 'api')
-    apidoc.main(['apidoc', package_dir, '-f',
-                 '-H', 'keystoneauth Modules',
-                 '-o', source_dir])
-
-
-def setup(app):
-    app.connect('builder-inited', run_apidoc)

doc/source/conf.py

@@ -23,12 +23,6 @@ import pbr.version
 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.
@@ -44,10 +38,6 @@ extensions = ['sphinx.ext.autodoc',
               '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

setup.cfg

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