diff --git a/README.rst b/README.rst index 3dc78310..1fc97869 100644 --- a/README.rst +++ b/README.rst @@ -12,8 +12,7 @@ wraps the Python 'ovs' and adds an event loop and friendly transactions. * Source: https://opendev.org/openstack/ovsdbapp/ * Bugs: https://bugs.launchpad.net/ovsdbapp -Features --------- +Features: * An thread-based event loop for using ovs.db.Idl * Transaction support diff --git a/doc/source/conf.py b/doc/source/conf.py index ad6f7dab..c75e8c0c 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -71,9 +71,9 @@ htmlhelp_basename = '%sdoc' % project # [howto/manual]). latex_documents = [ ('index', - '%s.tex' % project, + 'doc-ovsdbapp.tex', u'%s Documentation' % project, - u'OpenStack Foundation', 'manual'), + u'OpenStack Foundation', 'howto'), ] # Example configuration for intersphinx: refer to the Python standard library. diff --git a/doc/source/index.rst b/doc/source/index.rst index ee10e633..c7f3b76a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 .. include:: ../../README.rst -Contents --------- +---- .. toctree:: :maxdepth: 2 @@ -17,10 +11,10 @@ Contents user/index contributor/index -Indices and tables ------------------- +.. only:: html -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + .. rubric:: Indices and tables + * :ref:`genindex` + * :ref:`modindex` + * :ref:`search` diff --git a/tox.ini b/tox.ini index 23cae944..79cee7dc 100644 --- a/tox.ini +++ b/tox.ini @@ -36,6 +36,16 @@ deps = commands = 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] basepython = python3 deps =