diff options
| author | Stephen Finucane <sfinucan@redhat.com> | 2017-03-20 13:31:29 +0000 |
|---|---|---|
| committer | Stephen Finucane <sfinucan@redhat.com> | 2017-03-28 16:29:19 +0100 |
| commit | 9f471eede95b7c555c4b71673806bd11943460e0 (patch) | |
| tree | caea16b0650b1b24c51a66a091cc61e4b24aae19 /doc/ext | |
| parent | dd81ca0692ebe6c4892271da60a1e5eceba8d25c (diff) | |
| download | python-openstackclient-9f471eede95b7c555c4b71673806bd11943460e0.tar.gz | |
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
Diffstat (limited to 'doc/ext')
| -rw-r--r-- | doc/ext/__init__.py | 0 | ||||
| -rw-r--r-- | doc/ext/apidoc.py | 43 |
2 files changed, 0 insertions, 43 deletions
diff --git a/doc/ext/__init__.py b/doc/ext/__init__.py deleted file mode 100644 index e69de29b..00000000 --- a/doc/ext/__init__.py +++ /dev/null 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) |