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: I585a2fb8cf6450fb0a22808ce954bdf49464da04
This commit is contained in:
Anusha Ramineni 2018-04-11 09:46:17 +05:30 committed by Eric Kao
parent 09da4f84a1
commit ab907b8334
7 changed files with 9 additions and 20 deletions

3
doc/requirements.txt Normal file
View File

@ -0,0 +1,3 @@
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
openstackdocstheme>=1.18.1 # Apache-2.0
reno>=2.5.0 # Apache-2.0

View File

@ -36,9 +36,7 @@ sys.path.insert(0, os.path.abspath('../..'))
# Add any Sphinx extension module names here, as strings.
# They can be extensions coming with Sphinx (named 'sphinx.ext.*')
# or your custom ones.
extensions = ['sphinx.ext.autodoc',
'openstackdocstheme',
]
extensions = ['openstackdocstheme']
# The suffix of source filenames.
source_suffix = '.rst'

View File

@ -26,5 +26,4 @@ Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@ -3,7 +3,7 @@
============================================
.. toctree::
:maxdepth: 1
:maxdepth: 2
unreleased
queens

View File

@ -21,12 +21,3 @@ classifier =
[files]
packages =
congress_dashboard
[pbr]
autodoc_index_modules = True
warnerrors = True
[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc/source

View File

@ -13,10 +13,5 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
coverage!=4.4,>=4.0 # Apache-2.0
oslotest>=3.2.0 # Apache-2.0
# Docs Requirements
openstackdocstheme>=1.18.1 # Apache-2.0
reno>=2.5.0 # Apache-2.0
docutils>=0.11 # OSI-Approved Open Source, Public Domain
# Include horizon as test requirement
http://tarballs.openstack.org/horizon/horizon-master.tar.gz#egg=horizon

View File

@ -30,9 +30,12 @@ commands =
[testenv:docs]
setenv = DJANGO_SETTINGS_MODULE=congress_dashboard.test.settings
commands = python setup.py build_sphinx
deps = -r{toxinidir}/doc/requirements.txt
commands =
sphinx-build -W -b html doc/source doc/build/html
[testenv:releasenotes]
deps = -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
[flake8]