Browse Source

PDF documentation build

Story: 2006099
Task: 35124
Change-Id: I8f72e7759b35bf1033e1087ed0567c760293eec2
tags/15.0.0.0b1
elajkat 9 months ago
parent
commit
7227e7a180
4 changed files with 59 additions and 9 deletions
  1. +2
    -2
      doc/requirements.txt
  2. +7
    -1
      doc/source/conf.py
  3. +40
    -6
      doc/source/index.rst
  4. +10
    -0
      tox.ini

+ 2
- 2
doc/requirements.txt View File

@@ -1,8 +1,8 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
sphinx>=1.6.5,!=1.6.6,!=1.6.7,<2.0.0;python_version=='2.7' # BSD
sphinx>=1.6.5,!=1.6.6,!=1.6.7;python_version>='3.4' # BSD
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,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
openstackdocstheme>=1.20.0 # Apache-2.0
reno>=2.7.0 # Apache-2.0
doc8>=0.8.0 # Apache-2.0

+ 7
- 1
doc/source/conf.py View File

@@ -73,10 +73,16 @@ html_last_updated_fmt = '%Y-%m-%d %H:%M'
# [howto/manual]).
latex_documents = [
('index',
'%s.tex' % project,
'doc-%s.tex' % project,
u'%s Documentation' % project,
u'OpenStack Foundation', '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}',
}

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

@@ -1,6 +1,38 @@
.. cover title comes from README.rst
==========================
Welcome to networking-odl!
==========================

.. include:: ../../README.rst
.. Team and repository tags
.. only:: html

.. image:: http://governance.openstack.org/badges/networking-odl.svg
:target: http://governance.openstack.org/reference/tags/index.html

Summary
-------

OpenStack networking-odl is a library of drivers and plugins that integrates
OpenStack Neutron API with OpenDaylight Backend. For example it has ML2
driver and L3 plugin to enable communication of OpenStack Neutron L2
and L3 resources API to OpenDayLight Backend.

To report and discover bugs in networking-odl the following
link can be used:
https://bugs.launchpad.net/networking-odl

Any new code submission or proposal must follow the development
guidelines detailed in HACKING.rst and for further details this
link can be checked:
https://docs.openstack.org/networking-odl/latest/

The OpenDaylight homepage:
https://www.opendaylight.org/

Release notes for the project can be found at:
https://docs.openstack.org/releasenotes/networking-odl/

The project source code repository is located at:
https://opendev.org/openstack/networking-odl

Installation
------------
@@ -37,9 +69,11 @@ Reference Deployment Guide

reference/index

Indices and tables
------------------
.. only:: html

Indices and tables
------------------

* :ref:`genindex`
* :ref:`search`
* :ref:`genindex`
* :ref:`search`


+ 10
- 0
tox.ini View File

@@ -92,6 +92,16 @@ commands =
rm -rf doc/build
sphinx-build -W -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

[testenv:debug]
basepython = python3
# Uses default base python


Loading…
Cancel
Save