From 9f471eede95b7c555c4b71673806bd11943460e0 Mon Sep 17 00:00:00 2001
From: Stephen Finucane <sfinucan@redhat.com>
Date: Mon, 20 Mar 2017 13:31:29 +0000
Subject: [PATCH] doc: Remove local fork of apidoc

This is unnecessary as pbr has since been fixed. It was causing a broken
build as it didn't respect the '[pbr] autodoc_tree_excludes' setting in
setup.cfg.

The 'openstackclient/volume/v3' directory is an empty module containing
only an '__init__' file). Empty modules = unhappy autodoc, thus, this
module is ignored.

Change-Id: Ie355b14c14b7badccb5c25f7c17edbc5e4b3804f
---
 doc/ext/__init__.py |  0
 doc/ext/apidoc.py   | 43 -------------------------------------------
 doc/source/conf.py  |  5 -----
 setup.cfg           |  8 ++++++++
 4 files changed, 8 insertions(+), 48 deletions(-)
 delete mode 100644 doc/ext/__init__.py
 delete mode 100644 doc/ext/apidoc.py

diff --git a/doc/ext/__init__.py b/doc/ext/__init__.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/doc/ext/apidoc.py b/doc/ext/apidoc.py
deleted file mode 100644
index 5e18385a..00000000
--- a/doc/ext/apidoc.py
+++ /dev/null
@@ -1,43 +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.
-
-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, '..', '..',
-                                         'openstackclient'))
-    source_dir = path.join(app.srcdir, 'api')
-    apidoc.main(['apidoc', package_dir, '-f',
-                 '-H', 'openstackclient Modules',
-                 '-o', source_dir])
-
-
-def setup(app):
-    app.connect('builder-inited', run_apidoc)
diff --git a/doc/source/conf.py b/doc/source/conf.py
index a244ea09..42029146 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -22,10 +22,6 @@ import pbr.version
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 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__), '..')))
-
 # -- General configuration ----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -37,7 +33,6 @@ extensions = ['sphinx.ext.autodoc',
               'sphinx.ext.doctest',
               'sphinx.ext.todo',
               'oslosphinx',
-              'ext.apidoc',
               'stevedore.sphinxext',
               ]
 
diff --git a/setup.cfg b/setup.cfg
index 3a8d6724..cadbe72d 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -687,6 +687,14 @@ openstack.volume.v3 =
     volume_transfer_request_list = openstackclient.volume.v2.volume_transfer_request:ListTransferRequest
     volume_transfer_request_show = openstackclient.volume.v2.volume_transfer_request:ShowTransferRequest
 
+[pbr]
+autodoc_tree_index_modules = True
+autodoc_tree_excludes =
+    setup.py
+    openstackclient/volume/v3
+    openstackclient/tests/
+    openstackclient/tests/*
+
 [build_sphinx]
 source-dir = doc/source
 build-dir = doc/build