diff options
| -rw-r--r-- | doc/ext/__init__.py | 0 | ||||
| -rw-r--r-- | doc/ext/apidoc.py | 41 | ||||
| -rw-r--r-- | doc/source/conf.py | 6 | ||||
| -rw-r--r-- | setup.cfg | 4 |
4 files changed, 3 insertions, 48 deletions
diff --git a/doc/ext/__init__.py b/doc/ext/__init__.py deleted file mode 100644 index e69de29..0000000 --- a/doc/ext/__init__.py +++ /dev/null diff --git a/doc/ext/apidoc.py b/doc/ext/apidoc.py deleted file mode 100644 index c23d55f..0000000 --- a/doc/ext/apidoc.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2013 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(gordc): 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, '..', '..', 'pycadf')) - source_dir = path.join(app.srcdir, 'api') - apidoc.main(['apidoc', package_dir, '-f', - '-H', 'pyCADF 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 79129df..ea08a5b 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -10,10 +10,7 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys, os - -# NOTE(gordc): path for Sphinx ext.apidoc -sys.path.insert(0, os.path.abspath('..')) +import os # This is required for ReadTheDocs.org, but isn't a bad idea anyway. os.environ['DJANGO_SETTINGS_MODULE'] = 'openstack_dashboard.settings' @@ -37,7 +34,6 @@ extensions = [ 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'openstackdocstheme', - 'ext.apidoc' ] # Add any paths that contain templates here, relative to this directory. @@ -47,5 +47,5 @@ upload-dir = doc/build/html [pbr] warnerrors = True -#autodoc_tree_index_modules = True -#autodoc_tree_root = ./pycadf +autodoc_tree_index_modules = True +autodoc_tree_root = ./pycadf |