diff options
author | ZhongShengping <chdzsp@163.com> | 2018-03-02 09:00:54 +0800 |
---|---|---|
committer | Stephen Finucane <stephenfin@redhat.com> | 2019-04-02 14:28:24 +0100 |
commit | 7274bc23f1f1b29cfabf30a66f33a1a9b1eac927 (patch) | |
tree | fd59499ef0f3ad47b978ac06a4bf1772a5459a49 /doc | |
parent | f8882547a69aad500dc0bd2a2b89f4d460803c52 (diff) | |
download | oslo-concurrency-7274bc23f1f1b29cfabf30a66f33a1a9b1eac927.tar.gz |
Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html
For more detials information, please refer to:
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html
Change-Id: I4b1b023ff2c40f5b31429584fc1a77c0315ed2d9
Co-Authored-By: Stephen Finucane <stephenfin@redhat.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/requirements.txt | 9 | ||||
-rwxr-xr-x | doc/source/conf.py | 46 | ||||
-rw-r--r-- | doc/source/reference/index.rst | 1 |
3 files changed, 21 insertions, 35 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..572662f --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,9 @@ +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. +# this is required for the docs build jobs +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +openstackdocstheme>=1.18.1 # Apache-2.0 +reno>=2.5.0 # Apache-2.0 +fixtures>=3.0.0 # Apache-2.0/BSD +sphinxcontrib-apidoc>=0.2.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index fa7a79a..b163d37 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -12,17 +12,13 @@ # See the License for the specific language governing permissions and # limitations under the License. -import os -import sys - - -sys.path.insert(0, os.path.abspath('../..')) # -- General configuration ---------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', + 'sphinxcontrib.apidoc', 'openstackdocstheme', 'oslo_config.sphinxext', ] @@ -31,18 +27,6 @@ extensions = [ repository_name = 'openstack/oslo.concurrency' bug_project = 'oslo.concurrency' bug_tag = '' -html_last_updated_fmt = '%Y-%m-%d %H:%M' - -# autodoc generation is a bit aggressive and a nuisance when doing heavy -# text edit cycles. -# execute "export SPHINX_DEBUG=1" in your terminal to disable - -# A list of glob-style patterns that should be excluded when looking for source -# files. -exclude_patterns = [] - -# The suffix of source filenames. -source_suffix = '.rst' # The master toctree document. master_doc = 'index' @@ -61,26 +45,18 @@ add_module_names = True # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' -# -- Options for HTML output -------------------------------------------------- -# The theme to use for HTML and HTML Help pages. Major themes that come with -# Sphinx are currently 'default' and 'sphinxdoc'. -# html_theme_path = ["."] +# -- Options for HTML output ------------------------------------------------- + html_theme = 'openstackdocs' -# html_static_path = ['static'] -# Output file base name for HTML help builder. -htmlhelp_basename = '%sdoc' % project -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass -# [howto/manual]). -latex_documents = [ - ('index', - '%s.tex' % project, - u'%s Documentation' % project, - u'OpenStack Foundation', 'manual'), -] +# -- sphinxcontrib.apidoc configuration -------------------------------------- -# Example configuration for intersphinx: refer to the Python standard library. -# intersphinx_mapping = {'http://docs.python.org/': None} +apidoc_module_dir = '../../' +apidoc_output_dir = 'reference/api' +apidoc_excluded_paths = [ + 'oslo_concurrency/tests', + 'oslo_concurrency/_*', + 'setup.py', +] diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index 60abf32..fe64562 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -10,3 +10,4 @@ opts processutils watchdog + api/modules |