summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormelissaml <ma.lei@99cloud.net>2018-04-20 14:44:58 +0800
committerMorgan Fainberg <morgan.fainberg@gmail.com>2018-06-06 15:22:22 +0000
commita451b28c434be314c3e626fa3c4f444bb1acd979 (patch)
tree8c138e1caf91d5ed3a07afb4bf937ae7b9a085c6
parent83d0612e03471f56be3be2b521cc21974118cebe (diff)
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 http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html Co-Authored-By: Nguyen Hai <nguyentrihai93@gmail.com> Change-Id: Ia0a27229f09467980ff4af014001febb017bb36d
Notes
Notes (review): Code-Review+2: Morgan Fainberg <morgan.fainberg@gmail.com> Code-Review+2: Lance Bragstad <lbragstad@gmail.com> Workflow+1: Lance Bragstad <lbragstad@gmail.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Wed, 06 Jun 2018 22:13:59 +0000 Reviewed-on: https://review.openstack.org/562951 Project: openstack/keystonemiddleware Branch: refs/heads/master
-rw-r--r--doc/requirements.txt1
-rw-r--r--doc/source/conf.py16
-rw-r--r--setup.cfg13
-rw-r--r--test-requirements.txt1
-rw-r--r--tox.ini2
5 files changed, 14 insertions, 19 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 75c6c19..6e62d8d 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -7,6 +7,7 @@ doc8>=0.6.0 # Apache-2.0
7openstackdocstheme>=1.18.1 # Apache-2.0 7openstackdocstheme>=1.18.1 # Apache-2.0
8reno>=2.5.0 # Apache-2.0 8reno>=2.5.0 # Apache-2.0
9sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD 9sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
10sphinxcontrib-apidoc>=0.2.0 # BSD
10 11
11# For autodoc builds 12# For autodoc builds
12mock>=2.0.0 # BSD 13mock>=2.0.0 # BSD
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 0cef1f7..9e8aaff 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -10,7 +10,6 @@
10# All configuration values have a default; values that are commented out 10# All configuration values have a default; values that are commented out
11# serve to show the default. 11# serve to show the default.
12 12
13from __future__ import unicode_literals
14 13
15import os 14import os
16import sys 15import sys
@@ -37,14 +36,23 @@ sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__),
37# Add any Sphinx extension module names here, as strings. They can be 36# Add any Sphinx extension module names here, as strings. They can be
38# extensions 37# extensions
39# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 38# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
40extensions = ['sphinx.ext.autodoc', 39extensions = ['sphinx.ext.todo',
41 'sphinx.ext.todo',
42 'sphinx.ext.coverage', 40 'sphinx.ext.coverage',
43 'sphinx.ext.intersphinx', 41 'sphinx.ext.intersphinx',
44 'openstackdocstheme', 42 'openstackdocstheme',
45 'oslo_config.sphinxconfiggen' 43 'oslo_config.sphinxconfiggen',
44 'sphinxcontrib.apidoc',
46 ] 45 ]
47 46
47# sphinxcontrib.apidoc options
48apidoc_module_dir = '../../keystonemiddleware'
49apidoc_output_dir = 'api'
50apidoc_excluded_paths = [
51 'tests/*',
52 'tests',
53 'test']
54apidoc_separate_modules = True
55
48config_generator_config_file = '../../config-generator/keystonemiddleware.conf' 56config_generator_config_file = '../../config-generator/keystonemiddleware.conf'
49sample_config_basename = '_static/keystonemiddleware' 57sample_config_basename = '_static/keystonemiddleware'
50 58
diff --git a/setup.cfg b/setup.cfg
index bb2ed1c..685fe49 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -40,19 +40,6 @@ paste.filter_factory =
40 ec2_token = keystonemiddleware.ec2_token:filter_factory 40 ec2_token = keystonemiddleware.ec2_token:filter_factory
41 s3_token = keystonemiddleware.s3_token:filter_factory 41 s3_token = keystonemiddleware.s3_token:filter_factory
42 42
43[build_sphinx]
44source-dir = doc/source
45build-dir = doc/build
46all_files = 1
47warning-is-error = 1
48
49[pbr]
50autodoc_tree_index_modules = True
51autodoc_tree_excludes = setup.py
52
53[upload_sphinx]
54upload-dir = doc/build/html
55
56[compile_catalog] 43[compile_catalog]
57directory = keystonemiddleware/locale 44directory = keystonemiddleware/locale
58domain = keystonemiddleware 45domain = keystonemiddleware
diff --git a/test-requirements.txt b/test-requirements.txt
index 75e6bf5..f97ceaf 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -10,7 +10,6 @@ cryptography>=2.1 # BSD/Apache-2.0
10fixtures>=3.0.0 # Apache-2.0/BSD 10fixtures>=3.0.0 # Apache-2.0/BSD
11mock>=2.0.0 # BSD 11mock>=2.0.0 # BSD
12oslotest>=3.2.0 # Apache-2.0 12oslotest>=3.2.0 # Apache-2.0
13reno>=2.5.0 # Apache-2.0
14requests-mock>=1.2.0 # Apache-2.0 13requests-mock>=1.2.0 # Apache-2.0
15stevedore>=1.20.0 # Apache-2.0 14stevedore>=1.20.0 # Apache-2.0
16testrepository>=0.0.18 # Apache-2.0/BSD 15testrepository>=0.0.18 # Apache-2.0/BSD
diff --git a/tox.ini b/tox.ini
index 96b843e..4db5ca7 100644
--- a/tox.ini
+++ b/tox.ini
@@ -54,7 +54,7 @@ exclude = .venv,.tox,dist,doc,*egg,build
54deps = -r{toxinidir}/doc/requirements.txt 54deps = -r{toxinidir}/doc/requirements.txt
55commands= 55commands=
56 doc8 doc/source 56 doc8 doc/source
57 python setup.py build_sphinx 57 sphinx-build -W -b html doc/source doc/build/html
58 58
59[testenv:releasenotes] 59[testenv:releasenotes]
60deps = -r{toxinidir}/doc/requirements.txt 60deps = -r{toxinidir}/doc/requirements.txt