Merge "Added ``docs`` environment to tox.ini"
This commit is contained in:
commit
87fc4d39de
|
@ -1,3 +1,7 @@
|
||||||
|
=================
|
||||||
|
How to contribute
|
||||||
|
=================
|
||||||
|
|
||||||
If you would like to contribute to the development of OpenStack,
|
If you would like to contribute to the development of OpenStack,
|
||||||
you must follow the steps in the "If you're a developer, start here"
|
you must follow the steps in the "If you're a developer, start here"
|
||||||
section of this page:
|
section of this page:
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
===================================
|
===================================
|
||||||
oslo.db
|
Overview
|
||||||
===================================
|
===================================
|
||||||
|
|
||||||
oslo.db library
|
oslo.db library
|
||||||
|
|
|
@ -30,6 +30,14 @@ extensions = [
|
||||||
# text edit cycles.
|
# text edit cycles.
|
||||||
# execute "export SPHINX_DEBUG=1" in your terminal to disable
|
# execute "export SPHINX_DEBUG=1" in your terminal to disable
|
||||||
|
|
||||||
|
# A list of glob-style patterns that should be excluded when looking for source
|
||||||
|
# files.
|
||||||
|
exclude_patterns = [
|
||||||
|
'api/setup.rst', # workaround for https://launchpad.net/bugs/1260495
|
||||||
|
'api/tests.*', # avoid of docs generation from tests
|
||||||
|
'api/oslo.db.openstack.common.*', # skip common modules
|
||||||
|
]
|
||||||
|
|
||||||
# The suffix of source filenames.
|
# The suffix of source filenames.
|
||||||
source_suffix = '.rst'
|
source_suffix = '.rst'
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,11 @@
|
||||||
Welcome to oslo.db's documentation!
|
Welcome to oslo.db documentation!
|
||||||
===================================
|
=================================
|
||||||
|
|
||||||
|
The Oslo database handling library. Provides database connectivity
|
||||||
|
to the different backends and helper utils.
|
||||||
|
|
||||||
Contents:
|
Contents:
|
||||||
|
---------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
@ -12,7 +16,7 @@ Contents:
|
||||||
contributing
|
contributing
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
------------------
|
||||||
|
|
||||||
* :ref:`genindex`
|
* :ref:`genindex`
|
||||||
* :ref:`modindex`
|
* :ref:`modindex`
|
||||||
|
|
|
@ -1 +1 @@
|
||||||
.. include:: ../README.rst
|
.. include:: ../../README.rst
|
||||||
|
|
|
@ -54,3 +54,9 @@ input_file = oslo.db/locale/oslo.db.pot
|
||||||
keywords = _ gettext ngettext l_ lazy_gettext
|
keywords = _ gettext ngettext l_ lazy_gettext
|
||||||
mapping_file = babel.cfg
|
mapping_file = babel.cfg
|
||||||
output_file = oslo.db/locale/oslo.db.pot
|
output_file = oslo.db/locale/oslo.db.pot
|
||||||
|
|
||||||
|
[pbr]
|
||||||
|
# NOTE(viktors): uncomment ``warnerrors`` line, when setup.cfg we then
|
||||||
|
# want to treat sphinx warnings as errors
|
||||||
|
# warnerrors = True
|
||||||
|
autodoc_index_modules = True
|
||||||
|
|
4
tox.ini
4
tox.ini
|
@ -26,6 +26,10 @@ commands = {posargs}
|
||||||
[testenv:cover]
|
[testenv:cover]
|
||||||
commands = python setup.py testr --coverage --testr-args='{posargs}'
|
commands = python setup.py testr --coverage --testr-args='{posargs}'
|
||||||
|
|
||||||
|
[testenv:docs]
|
||||||
|
commands =
|
||||||
|
python setup.py build_sphinx
|
||||||
|
|
||||||
[flake8]
|
[flake8]
|
||||||
# H803 skipped on purpose per list discussion.
|
# H803 skipped on purpose per list discussion.
|
||||||
# E123, E125 skipped as they are invalid PEP-8.
|
# E123, E125 skipped as they are invalid PEP-8.
|
||||||
|
|
Loading…
Reference in New Issue