openstack/kuryr-kubernetes
Code Issues Proposed changes

Follow the new PTI for document build

Browse Source 
REF:
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

This also re-organizes index.rst

Change-Id: Ic2509e76d03c159cf40e84f6b5912fdabe826c8d
This commit is contained in:
Nguyen Hai 2018-06-02 11:27:42 +09:00
parent a8304701af
commit 085ad0a6cf
5 changed files with 14 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt Normal file
View File

@ -0,0 +1,6 @@
# 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.18.1 # Apache-2.0
reno>=2.5.0 # Apache-2.0

10
doc/source/index.rst
View File

@ -6,8 +6,8 @@
Welcome to kuryr-kubernetes's documentation!
============================================
Contents:
Contents
--------
.. toctree::
:maxdepth: 3
@ -17,7 +17,7 @@ Contents:
contributing
Developer Docs
==============
--------------
.. toctree::
:maxdepth: 3
@ -25,7 +25,7 @@ Developer Docs
devref/index
Design Specs
============
------------
.. toctree::
:maxdepth: 1
@ -36,7 +36,7 @@ Design Specs
specs/queens/network_policy
Indices and tables
==================
------------------
* :ref:`genindex`
* :ref:`search`

9
setup.cfg
View File

@ -87,15 +87,6 @@ kuryr_kubernetes.controller.handlers =
packages =
kuryr_kubernetes
[build_sphinx]
source-dir = doc/source
build-dir = doc/build
all_files = 1
warning-is-error = 1
[upload_sphinx]
upload-dir = doc/build/html
[compile_catalog]
directory = kuryr-kubernetes/locale
domain = kuryr-kubernetes

3
test-requirements.txt
View File

@ -9,11 +9,8 @@ ddt>=1.0.1 # MIT
docutils>=0.11 # OSI-Approved Open Source, Public Domain
mock>=2.0.0 # BSD
python-subunit>=1.0.0 # Apache-2.0/BSD
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
os-testr>=1.0.0 # Apache-2.0
openstackdocstheme>=1.18.1 # Apache-2.0
oslotest>=3.2.0 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD
testscenarios>=0.4 # Apache-2.0/BSD
testtools>=2.2.0 # MIT
reno>=2.5.0 # Apache-2.0

4
tox.ini
View File

@ -46,7 +46,8 @@ commands =
coverage report
[testenv:docs]
commands = python setup.py build_sphinx
deps = -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -W -b html doc/source doc/build/html
[flake8]
show-source = true
@ -70,6 +71,7 @@ local-check-factory = neutron_lib.hacking.checks.factory
commands = oslo-config-generator --config-file=etc/oslo-config-generator/kuryr.conf
[testenv:releasenotes]
deps = -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
[testenv:lower-constraints]