diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 6e5eeec..442f084 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,16 +1,16 @@ If you would like to contribute to the development of OpenStack, you must follow the steps in this page: - https://docs.openstack.org/infra/manual/developers.html +https://docs.openstack.org/infra/manual/developers.html Once those steps have been completed, changes to OpenStack should be submitted for review via the Gerrit tool, following the workflow documented at: - https://docs.openstack.org/infra/manual/developers.html#development-workflow +https://docs.openstack.org/infra/manual/developers.html#development-workflow Pull requests submitted through GitHub will be ignored. Bugs should be filed on Launchpad, not GitHub: - https://bugs.launchpad.net/networking-l2gw +https://bugs.launchpad.net/networking-l2gw diff --git a/doc/requirements.txt b/doc/requirements.txt index f3a356b..d91f05b 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,5 +2,5 @@ # 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,<2.0.0;python_version=='2.7' # BSD -sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD +sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD openstackdocstheme>=1.20.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 2f9c0e7..a6e072c 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -71,10 +71,19 @@ htmlhelp_basename = '%sdoc' % project # [howto/manual]). latex_documents = [ ('index', - '%s.tex' % project, - u'%s Documentation' % project, - u'OpenStack Foundation', 'manual'), + 'doc-%s.tex' % project, + u'Networking L2GW Documentation', + u'networking-l2gw developers', 'manual'), ] # Example configuration for intersphinx: refer to the Python standard library. #intersphinx_mapping = {'http://docs.python.org/': None} + +latex_elements = { + 'makeindex': '', + 'printindex': '', + 'preamble': r'\setcounter{tocdepth}{3}', + # openany: Skip blank pages in generated PDFs + # oneside: Use the same page layout for both even and odd pages + 'extraclassoptions': 'openany,oneside', +} diff --git a/doc/source/index.rst b/doc/source/index.rst index 1a774b0..d640b9e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -6,20 +6,18 @@ Welcome to networking-l2gw's documentation! ======================================================== -Contents: - .. toctree:: :maxdepth: 2 - readme + Introduction installation usage contributing -Indices and tables -================== +.. only:: html -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + .. rubric:: Indices: + * :ref:`genindex` + * :ref:`modindex` + * :ref:`search` diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 45eeba5..1852b4e 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -1,7 +1,6 @@ - -======== -Overview -======== +===== +Usage +===== .. _whatisl2gw: diff --git a/tox.ini b/tox.ini index 6bf84b4..e78726d 100644 --- a/tox.ini +++ b/tox.ini @@ -40,6 +40,15 @@ deps = -c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/ -r{toxinidir}/doc/requirements.txt commands = sphinx-build -W -d doc/build/doctrees -b html 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 [flake8] # H803 skipped on purpose per list discussion.