Merge "Follow the new PTI for document build"
This commit is contained in:
commit
a614c845b2
|
@ -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
|
General Info
|
||||||
============
|
------------
|
||||||
|
|
||||||
.. include:: ../../../CONTRIBUTING.rst
|
.. include:: ../../../CONTRIBUTING.rst
|
||||||
|
|
||||||
Approved Specs
|
Approved Specs
|
||||||
==============
|
--------------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
|
@ -1,7 +1,8 @@
|
||||||
Welcome to karborclient's documentation!
|
Welcome to karborclient's documentation!
|
||||||
========================================================
|
========================================
|
||||||
|
|
||||||
Contents:
|
Contents
|
||||||
|
--------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
@ -12,9 +13,8 @@ Contents:
|
||||||
contributor/index
|
contributor/index
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
------------------
|
||||||
|
|
||||||
* :ref:`genindex`
|
* :ref:`genindex`
|
||||||
* :ref:`modindex`
|
|
||||||
* :ref:`search`
|
* :ref:`search`
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
############
|
============
|
||||||
Introduction
|
Introduction
|
||||||
############
|
============
|
||||||
|
|
||||||
.. include:: ../../README.rst
|
.. include:: ../../README.rst
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
========
|
=====
|
||||||
Usage
|
Usage
|
||||||
========
|
=====
|
||||||
|
|
||||||
To use karborclient in a project::
|
To use karborclient in a project::
|
||||||
|
|
||||||
|
|
|
@ -89,14 +89,5 @@ keywords = _ gettext ngettext l_ lazy_gettext
|
||||||
mapping_file = babel.cfg
|
mapping_file = babel.cfg
|
||||||
output_file = karborclient/locale/karborclient.pot
|
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]
|
[wheel]
|
||||||
universal = 1
|
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
|
coverage!=4.4,>=4.0 # Apache-2.0
|
||||||
python-subunit>=1.0.0 # Apache-2.0/BSD
|
python-subunit>=1.0.0 # Apache-2.0/BSD
|
||||||
docutils>=0.11 # OSI-Approved Open Source, Public Domain
|
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
|
oslotest>=3.2.0 # Apache-2.0
|
||||||
python-openstackclient>=3.12.0 # Apache-2.0
|
python-openstackclient>=3.12.0 # Apache-2.0
|
||||||
requests-mock>=1.2.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
|
coverage report
|
||||||
|
|
||||||
[testenv:docs]
|
[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]
|
[testenv:debug]
|
||||||
commands = oslo_debug_helper -t karborclient/tests {posargs}
|
commands = oslo_debug_helper -t karborclient/tests {posargs}
|
||||||
|
@ -38,7 +39,7 @@ commands = oslo_debug_helper -t karborclient/tests {posargs}
|
||||||
[flake8]
|
[flake8]
|
||||||
|
|
||||||
show-source = True
|
show-source = True
|
||||||
ignore =
|
ignore =
|
||||||
builtins = _
|
builtins = _
|
||||||
exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,tools
|
exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,tools
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue