summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorZhongShengping <chdzsp@163.com>2018-03-02 09:59:11 +0800
committerBen Nemec <bnemec@redhat.com>2019-12-16 22:09:55 +0000
commit498dd44b710f275c9352e44b95048af56fa11f20 (patch)
tree68ba4a27b993542444ab4961fff333e2fd4a1ae5 /doc
parentb93f51c1aa85ca4735118668d1f890ca0fbe941d (diff)
downloadoslo-policy-498dd44b710f275c9352e44b95048af56fa11f20.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: I1c10b87297a23e010613e951f65913bb54baf6b9 Co-Authored-By: Stephen Finucane <sfinucan@redhat.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/source/conf.py39
-rw-r--r--doc/source/reference/index.rst1
2 files changed, 9 insertions, 31 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index f7095d2..c2b91e4 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -12,11 +12,7 @@
# 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 ----------------------------------------------------
+# -- 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.
@@ -24,7 +20,6 @@ extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.extlinks',
'sphinxcontrib.apidoc',
- #'sphinx.ext.intersphinx',
'openstackdocstheme',
'oslo_config.sphinxext',
]
@@ -44,10 +39,6 @@ source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ['api/oslo_policy.tests.*', 'api/setup.rst']
-
# General information about the project.
project = u'oslo.policy'
copyright = u'2014, OpenStack Foundation'
@@ -66,36 +57,24 @@ pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
modindex_common_prefix = ['oslo_policy.']
-# -- Options for HTML output --------------------------------------------------
+
+# -- 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 = ["."]
-# html_theme = '_theme'
-# html_static_path = ['static']
html_theme = 'openstackdocs'
-# 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'),
-]
-# Shortened external links.
+# -- sphinx.ext.extlinks configuration ---------------------------------------
+
extlinks = {
'example': (source_tree + '/oslo_policy/%s', ''),
}
-# Example configuration for intersphinx: refer to the Python standard library.
-#intersphinx_mapping = {'http://docs.python.org/': None}
-
# -- sphinxcontrib.apidoc configuration --------------------------------------
+
apidoc_module_dir = '../../oslo_policy'
apidoc_output_dir = 'reference/api'
+apidoc_excluded_paths = [
+ 'tests',
+]
diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst
index 6284450..512a8b9 100644
--- a/doc/source/reference/index.rst
+++ b/doc/source/reference/index.rst
@@ -5,4 +5,3 @@
.. toctree::
api/modules
-