Browse Source

PDF documentation build

Change-Id: I3fd44c8a6908261a06d274d7901c86a9ffabcfe6
stable/train
elajkat 2 years ago
committed by Lajos Katona
parent
commit
b6df509edf
6 changed files with 34 additions and 19 deletions
  1. +3
    -3
      CONTRIBUTING.rst
  2. +1
    -1
      doc/requirements.txt
  3. +12
    -3
      doc/source/conf.py
  4. +6
    -8
      doc/source/index.rst
  5. +3
    -4
      doc/source/usage.rst
  6. +9
    -0
      tox.ini

+ 3
- 3
CONTRIBUTING.rst View File

@ -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

+ 1
- 1
doc/requirements.txt View File

@ -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

+ 12
- 3
doc/source/conf.py View File

@ -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',
}

+ 6
- 8
doc/source/index.rst View File

@ -6,20 +6,18 @@
Welcome to networking-l2gw's documentation!
========================================================
Contents:
.. toctree::
:maxdepth: 2
readme
Introduction <readme>
installation
usage
contributing
Indices and tables
==================
.. only:: html
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. rubric:: Indices:
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

+ 3
- 4
doc/source/usage.rst View File

@ -1,7 +1,6 @@
========
Overview
========
=====
Usage
=====
.. _whatisl2gw:


+ 9
- 0
tox.ini View File

@ -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.


Loading…
Cancel
Save