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 - Remove the '[build_sphinx]' as described in: http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html - This patch also changes minor mistakes in docs. Change-Id: Iec58d57d59b98c6086910e532e16f1e417815c95
This commit is contained in:
parent
71034945a3
commit
01d1aa0da9
|
@ -0,0 +1,5 @@
|
|||
# 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
|
|
@ -3,12 +3,12 @@ Contributing
|
|||
============
|
||||
|
||||
General Info
|
||||
============
|
||||
------------
|
||||
|
||||
.. include:: ../../../CONTRIBUTING.rst
|
||||
|
||||
Approved Specs
|
||||
==============
|
||||
--------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
|
|
@ -1,7 +1,8 @@
|
|||
Welcome to karborclient's documentation!
|
||||
========================================================
|
||||
========================================
|
||||
|
||||
Contents:
|
||||
Contents
|
||||
--------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
@ -12,9 +13,8 @@ Contents:
|
|||
contributor/index
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
------------------
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
############
|
||||
============
|
||||
Introduction
|
||||
############
|
||||
============
|
||||
|
||||
.. include:: ../../README.rst
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
========
|
||||
=====
|
||||
Usage
|
||||
========
|
||||
=====
|
||||
|
||||
To use karborclient in a project::
|
||||
|
||||
|
|
|
@ -89,14 +89,5 @@ keywords = _ gettext ngettext l_ lazy_gettext
|
|||
mapping_file = babel.cfg
|
||||
output_file = karborclient/locale/karborclient.pot
|
||||
|
||||
[build_sphinx]
|
||||
source-dir = doc/source
|
||||
build-dir = doc/build
|
||||
all_files = 1
|
||||
warning-is-error = 1
|
||||
|
||||
[upload_sphinx]
|
||||
upload-dir = doc/build/html
|
||||
|
||||
[wheel]
|
||||
universal = 1
|
||||
|
|
|
@ -7,8 +7,6 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
|
|||
coverage!=4.4,>=4.0 # Apache-2.0
|
||||
python-subunit>=1.0.0 # Apache-2.0/BSD
|
||||
docutils>=0.11 # OSI-Approved Open Source, Public Domain
|
||||
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
|
||||
openstackdocstheme>=1.18.1 # Apache-2.0
|
||||
oslotest>=3.2.0 # Apache-2.0
|
||||
python-openstackclient>=3.12.0 # Apache-2.0
|
||||
requests-mock>=1.2.0 # Apache-2.0
|
||||
|
|
5
tox.ini
5
tox.ini
|
@ -30,7 +30,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
|
||||
|
||||
[testenv:debug]
|
||||
commands = oslo_debug_helper -t karborclient/tests {posargs}
|
||||
|
@ -38,6 +39,6 @@ commands = oslo_debug_helper -t karborclient/tests {posargs}
|
|||
[flake8]
|
||||
|
||||
show-source = True
|
||||
ignore =
|
||||
ignore =
|
||||
builtins = _
|
||||
exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,tools
|
||||
|
|
Loading…
Reference in New Issue