Skip to content

Commit 9f471ee

Browse files
stephenfinstephenfin
committed
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
1 parent dd81ca0 commit 9f471ee

4 files changed

Lines changed: 8 additions & 48 deletions

File tree

‎doc/ext/__init__.py‎

Whitespace-only changes.

‎doc/ext/apidoc.py‎

Lines changed: 0 additions & 43 deletions
This file was deleted.

‎doc/source/conf.py‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,6 @@
2222
# documentation root, use os.path.abspath to make it absolute, like shown here.
2323
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..')))
2424

25-
# NOTE(blk-u): Path for our Sphinx extension, remove when
26-
# https://launchpad.net/bugs/1260495 is fixed.
27-
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
28-
2925
# -- General configuration ----------------------------------------------------
3026

3127
# If your documentation needs a minimal Sphinx version, state it here.
@@ -37,7 +33,6 @@
3733
'sphinx.ext.doctest',
3834
'sphinx.ext.todo',
3935
'oslosphinx',
40-
'ext.apidoc',
4136
'stevedore.sphinxext',
4237
]
4338

‎setup.cfg‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -687,6 +687,14 @@ openstack.volume.v3 =
687687
volume_transfer_request_list = openstackclient.volume.v2.volume_transfer_request:ListTransferRequest
688688
volume_transfer_request_show = openstackclient.volume.v2.volume_transfer_request:ShowTransferRequest
689689

690+
[pbr]
691+
autodoc_tree_index_modules = True
692+
autodoc_tree_excludes =
693+
setup.py
694+
openstackclient/volume/v3
695+
openstackclient/tests/
696+
openstackclient/tests/*
697+
690698
[build_sphinx]
691699
source-dir = doc/source
692700
build-dir = doc/build

0 commit comments

Comments
 (0)