Changes to allow sphinx to build correctly

This should allow our documentation to post to
http://docs.openstack.org/developer/anchor

Running locally both pass:
python setup.py build_sphinx
tox -e venv python setup.py build_sphinx

"tox -e docs" still works and you can run
that if you desire.

"tox -e venv python setup.py build_sphinx"
is what's required to work by infra so that
documentation can be built upstream and
published to the developer documentation pages.
It also allows the documentation jobs to run in
the gate so that documentation is built at
review time.

Change-Id: If67961a1b68223ed4ca002037cb7e8c6a51fbe3e
This commit is contained in:
Robert Clark 2015-09-03 12:43:39 -07:00
parent 1e4684f4f5
commit 6040112312
10 changed files with 13 additions and 4 deletions

View File

@ -98,12 +98,12 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'alabaster'
#html_theme = 'alabaster'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []

View File

@ -21,6 +21,11 @@ classifier =
Programming Language :: Python :: 3.4
Topic :: Security
[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc/source
[entry_points]
anchor.signing_backends =
anchor = anchor.certificate_ops:sign

View File

@ -11,3 +11,7 @@ testrepository>=0.0.18
testscenarios>=0.4
testtools>=1.4.0
requests-mock>=0.6.0 # Apache-2.0
# Documentation build requirements
sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2
oslosphinx>=2.5.0 # Apache-2.0

View File

@ -20,8 +20,8 @@ deps =
doc8
sphinx
commands =
sphinx-build -W -b html -d {envtmpdir}/doctrees docs docs/_build/html
doc8 --allow-long-titles docs/ --ignore-path docs/_build/
sphinx-build -W -b html -d {envtmpdir}/doctrees doc/source doc/_build/html
doc8 --allow-long-titles doc/source --ignore-path doc/_build/
[testenv:pep8]
commands =