Merge "PDF documentation build"
This commit is contained in:
commit
4310bd2a06
@ -12,8 +12,7 @@ wraps the Python 'ovs' and adds an event loop and friendly transactions.
|
|||||||
* Source: https://opendev.org/openstack/ovsdbapp/
|
* Source: https://opendev.org/openstack/ovsdbapp/
|
||||||
* Bugs: https://bugs.launchpad.net/ovsdbapp
|
* Bugs: https://bugs.launchpad.net/ovsdbapp
|
||||||
|
|
||||||
Features
|
Features:
|
||||||
--------
|
|
||||||
|
|
||||||
* An thread-based event loop for using ovs.db.Idl
|
* An thread-based event loop for using ovs.db.Idl
|
||||||
* Transaction support
|
* Transaction support
|
||||||
|
@ -71,9 +71,9 @@ htmlhelp_basename = '%sdoc' % project
|
|||||||
# [howto/manual]).
|
# [howto/manual]).
|
||||||
latex_documents = [
|
latex_documents = [
|
||||||
('index',
|
('index',
|
||||||
'%s.tex' % project,
|
'doc-ovsdbapp.tex',
|
||||||
u'%s Documentation' % project,
|
u'%s Documentation' % project,
|
||||||
u'OpenStack Foundation', 'manual'),
|
u'OpenStack Foundation', 'howto'),
|
||||||
]
|
]
|
||||||
|
|
||||||
# Example configuration for intersphinx: refer to the Python standard library.
|
# Example configuration for intersphinx: refer to the Python standard library.
|
||||||
|
@ -1,14 +1,8 @@
|
|||||||
.. ovsdbapp documentation master file, created by
|
|
||||||
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
|
|
||||||
You can adapt this file completely to your liking, but it should at least
|
|
||||||
contain the root `toctree` directive.
|
|
||||||
|
|
||||||
.. the main title comes from README.rst
|
.. the main title comes from README.rst
|
||||||
|
|
||||||
.. include:: ../../README.rst
|
.. include:: ../../README.rst
|
||||||
|
|
||||||
Contents
|
----
|
||||||
--------
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
@ -17,10 +11,10 @@ Contents
|
|||||||
user/index
|
user/index
|
||||||
contributor/index
|
contributor/index
|
||||||
|
|
||||||
Indices and tables
|
.. only:: html
|
||||||
------------------
|
|
||||||
|
|
||||||
* :ref:`genindex`
|
.. rubric:: Indices and tables
|
||||||
* :ref:`modindex`
|
|
||||||
* :ref:`search`
|
|
||||||
|
|
||||||
|
* :ref:`genindex`
|
||||||
|
* :ref:`modindex`
|
||||||
|
* :ref:`search`
|
||||||
|
10
tox.ini
10
tox.ini
@ -36,6 +36,16 @@ deps =
|
|||||||
commands =
|
commands =
|
||||||
sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
|
sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
|
||||||
|
|
||||||
|
[testenv:pdf-docs]
|
||||||
|
basepython = python3
|
||||||
|
envdir = {toxworkdir}/docs
|
||||||
|
deps = {[testenv:docs]deps}
|
||||||
|
whitelist_externals =
|
||||||
|
make
|
||||||
|
commands =
|
||||||
|
sphinx-build -W -b latex doc/source doc/build/pdf
|
||||||
|
make -C doc/build/pdf
|
||||||
|
|
||||||
[testenv:releasenotes]
|
[testenv:releasenotes]
|
||||||
basepython = python3
|
basepython = python3
|
||||||
deps =
|
deps =
|
||||||
|
Loading…
x
Reference in New Issue
Block a user