diff --git a/.zuul.yaml b/.zuul.yaml index 294161a5..e2fd4c26 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -2,6 +2,7 @@ templates: - openstack-lower-constraints-jobs - openstack-cover-jobs-neutron + - build-openstack-docs-pti - check-requirements - openstack-python3-ussuri-jobs-neutron - tap-as-a-service-tempest-plugin-jobs diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 00000000..0dc55127 --- /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. +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +openstackdocstheme>=1.30.0 # Apache-2.0 +reno>=2.5.0 # Apache-2.0 + +sphinxcontrib-blockdiag>=1.5.4 # BSD +sphinxcontrib-seqdiag>=0.8.4 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 5d5fd5d0..9cd1910d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -22,10 +22,15 @@ sys.path.insert(0, os.path.abspath('../..')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', - #'sphinx.ext.intersphinx', - 'oslosphinx' + 'openstackdocstheme' ] +# openstackdocstheme options +repository_name = 'x/tap-as-a-service' +bug_project = 'tap-as-a-service' +bug_tag = '' +html_theme = 'openstackdocs' + # 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 @@ -66,10 +71,19 @@ htmlhelp_basename = '%sdoc' % project # [howto/manual]). latex_documents = [ ('index', - '%s.tex' % project, - u'%s Documentation' % project, + 'doc-tap-as-a-service.tex', + u'Tap as a Service Documentation', u'OpenStack Foundation', 'manual'), ] # Example configuration for intersphinx: refer to the Python standard library. #intersphinx_mapping = {'http://docs.python.org/': None} + +latex_elements = { + 'makeindex': '', + 'printindex': '', + 'preamble': r'\setcounter{tocdepth}{3}', + # openany: Skip blank pages in generated PDFs + # oneside: Use the same page layout for both even and odd pages + 'extraclassoptions': 'openany,oneside', +} diff --git a/specs/mitaka/tap-as-a-service.rst b/specs/mitaka/tap-as-a-service.rst index 9fa468c1..f98b392e 100644 --- a/specs/mitaka/tap-as-a-service.rst +++ b/specs/mitaka/tap-as-a-service.rst @@ -151,7 +151,7 @@ schemas. | status | String | R, all | N/A | N/A | The operation status of | | | | | | | the resource | | | | | | | (ACTIVE, PENDING_foo, | -| | | | | | ERROR, ...) | +| | | | | | ERROR, ...) | +-------------+--------+----------+-----------+---------------+-------------------------+ 2. tap_flow @@ -186,7 +186,7 @@ schemas. | status | String | R, all | N/A | N/A | The operation status of | | | | | | | the resource | | | | | | | (ACTIVE, PENDING_foo, | -| | | | | | ERROR, ...) | +| | | | | | ERROR, ...) | +----------------+--------+----------+-----------+---------------+-------------------------+ @@ -469,6 +469,3 @@ References .. [2] Service base and insertion https://review.openstack.org/#/c/93128 - -.. [3] NFV unaddressed interfaces - https://review.openstack.org/#/c/97715/ diff --git a/test-requirements.txt b/test-requirements.txt index 942b1fe2..c002bd5c 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -8,7 +8,6 @@ coverage!=4.4,>=4.0 # Apache-2.0 python-subunit>=1.0.0 # Apache-2.0/BSD psycopg2>=2.7.5 # LGPL/ZPL PyMySQL>=0.7.6 # MIT License -oslosphinx>=4.7.0 # Apache-2.0 oslotest>=3.2.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0 stestr>=1.0.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 57c9b6a4..fc30a9f6 100644 --- a/tox.ini +++ b/tox.ini @@ -2,6 +2,7 @@ envlist = docs,py35,py27,pep8 minversion = 1.8 skipsdist = True +ignore_basepython_conflict = True [testenv] basepython = python3 @@ -9,7 +10,7 @@ setenv = VIRTUAL_ENV={envdir} PYTHONWARNINGS=default::DeprecationWarning usedevelop = True install_command = pip install {opts} {packages} -deps = -c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt} +deps = -c{env:TOX_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt} -r{toxinidir}/requirements.txt -r{toxinidir}/test-requirements.txt commands = find . -type f -name "*.py[c|o]" -delete @@ -45,7 +46,9 @@ commands = coverage xml -o cover/coverage.xml [testenv:docs] -commands = python setup.py build_sphinx +deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} + -r{toxinidir}/doc/requirements.txt +commands = sphinx-build -W -d doc/build/doctrees -b html doc/source doc/build/html [testenv:releasenotes] commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html