diff options
author | Zuul <zuul@review.openstack.org> | 2018-06-06 22:13:59 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2018-06-06 22:13:59 +0000 |
commit | c5171adb2baae0e2dc090d6e49090e114202c787 (patch) | |
tree | 4e7527e36a124951b6d9a5f9042db6f9274b2ee8 | |
parent | 64b5e9e8821d5fbb0eb086b4e88dc18a822b5f76 (diff) | |
parent | a451b28c434be314c3e626fa3c4f444bb1acd979 (diff) |
Merge "Follow the new PTI for document build"
-rw-r--r-- | doc/requirements.txt | 1 | ||||
-rw-r--r-- | doc/source/conf.py | 16 | ||||
-rw-r--r-- | setup.cfg | 13 | ||||
-rw-r--r-- | test-requirements.txt | 1 | ||||
-rw-r--r-- | tox.ini | 2 |
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 | |||
7 | openstackdocstheme>=1.18.1 # Apache-2.0 | 7 | openstackdocstheme>=1.18.1 # Apache-2.0 |
8 | reno>=2.5.0 # Apache-2.0 | 8 | reno>=2.5.0 # Apache-2.0 |
9 | sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD | 9 | sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD |
10 | sphinxcontrib-apidoc>=0.2.0 # BSD | ||
10 | 11 | ||
11 | # For autodoc builds | 12 | # For autodoc builds |
12 | mock>=2.0.0 # BSD | 13 | mock>=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 | ||
13 | from __future__ import unicode_literals | ||
14 | 13 | ||
15 | import os | 14 | import os |
16 | import sys | 15 | import 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. |
40 | extensions = ['sphinx.ext.autodoc', | 39 | extensions = ['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 | ||
48 | apidoc_module_dir = '../../keystonemiddleware' | ||
49 | apidoc_output_dir = 'api' | ||
50 | apidoc_excluded_paths = [ | ||
51 | 'tests/*', | ||
52 | 'tests', | ||
53 | 'test'] | ||
54 | apidoc_separate_modules = True | ||
55 | |||
48 | config_generator_config_file = '../../config-generator/keystonemiddleware.conf' | 56 | config_generator_config_file = '../../config-generator/keystonemiddleware.conf' |
49 | sample_config_basename = '_static/keystonemiddleware' | 57 | sample_config_basename = '_static/keystonemiddleware' |
50 | 58 | ||
@@ -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] | ||
44 | source-dir = doc/source | ||
45 | build-dir = doc/build | ||
46 | all_files = 1 | ||
47 | warning-is-error = 1 | ||
48 | |||
49 | [pbr] | ||
50 | autodoc_tree_index_modules = True | ||
51 | autodoc_tree_excludes = setup.py | ||
52 | |||
53 | [upload_sphinx] | ||
54 | upload-dir = doc/build/html | ||
55 | |||
56 | [compile_catalog] | 43 | [compile_catalog] |
57 | directory = keystonemiddleware/locale | 44 | directory = keystonemiddleware/locale |
58 | domain = keystonemiddleware | 45 | domain = keystonemiddleware |
diff --git a/test-requirements.txt b/test-requirements.txt index dd72e63..ef2890e 100644 --- a/test-requirements.txt +++ b/test-requirements.txt | |||
@@ -10,7 +10,6 @@ cryptography>=2.1 # BSD/Apache-2.0 | |||
10 | fixtures>=3.0.0 # Apache-2.0/BSD | 10 | fixtures>=3.0.0 # Apache-2.0/BSD |
11 | mock>=2.0.0 # BSD | 11 | mock>=2.0.0 # BSD |
12 | oslotest>=3.2.0 # Apache-2.0 | 12 | oslotest>=3.2.0 # Apache-2.0 |
13 | reno>=2.5.0 # Apache-2.0 | ||
14 | requests-mock>=1.2.0 # Apache-2.0 | 13 | requests-mock>=1.2.0 # Apache-2.0 |
15 | stevedore>=1.20.0 # Apache-2.0 | 14 | stevedore>=1.20.0 # Apache-2.0 |
16 | stestr # Apache-2.0 | 15 | stestr # Apache-2.0 |
@@ -61,7 +61,7 @@ exclude = .venv,.tox,dist,doc,*egg,build | |||
61 | deps = -r{toxinidir}/doc/requirements.txt | 61 | deps = -r{toxinidir}/doc/requirements.txt |
62 | commands= | 62 | commands= |
63 | doc8 doc/source | 63 | doc8 doc/source |
64 | python setup.py build_sphinx | 64 | sphinx-build -W -b html doc/source doc/build/html |
65 | 65 | ||
66 | [testenv:releasenotes] | 66 | [testenv:releasenotes] |
67 | deps = -r{toxinidir}/doc/requirements.txt | 67 | deps = -r{toxinidir}/doc/requirements.txt |