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: I6af0fdd6d1efacb47692b89c329e45ac59fef7cb Closes-Bug: #1260495
This commit is contained in:
parent
c0fdd027e3
commit
6f98a9e2bd
@ -1,45 +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.
|
||||
|
||||
# NOTE(dstanek): 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(dstanek): 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, '..', '..', 'keystone'))
|
||||
source_dir = path.join(app.srcdir, 'api')
|
||||
apidoc.main(['apidoc', package_dir, '-f',
|
||||
'-H', 'Keystone Modules',
|
||||
'-o', source_dir])
|
||||
|
||||
|
||||
def setup(app):
|
||||
app.connect('builder-inited', run_apidoc)
|
@ -24,14 +24,8 @@
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
import sys
|
||||
import os
|
||||
|
||||
# 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.
|
||||
sys.path.insert(0, os.path.abspath('..')) # NOTE(dstanek): path for our
|
||||
# Sphinx extension
|
||||
|
||||
# NOTE(dstanek): adds _ to the builtins so keystone modules can be imported
|
||||
__builtins__['_'] = str
|
||||
@ -49,10 +43,6 @@ extensions = ['sphinx.ext.autodoc',
|
||||
'sphinx.ext.coverage',
|
||||
'sphinx.ext.viewcode',
|
||||
'oslosphinx',
|
||||
# NOTE(dstanek): 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
|
||||
|
@ -56,8 +56,7 @@ msgid_bugs_address = https://bugs.launchpad.net/keystone
|
||||
# Sphinx extension when https://launchpad.net/bugs/1260495 is fixed.
|
||||
[pbr]
|
||||
warnerrors = True
|
||||
#autodoc_tree_index_modules = True
|
||||
#autodoc_tree_root = ./keystone
|
||||
autodoc_tree_index_modules = True
|
||||
|
||||
[entry_points]
|
||||
console_scripts =
|
||||
|
Loading…
x
Reference in New Issue
Block a user