Browse Source

PDF documentation build

Story: 2006099
Task: 35124
Change-Id: I8f72e7759b35bf1033e1087ed0567c760293eec2
tags/15.0.0.0b1
elajkat 3 weeks 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 @@
1 1
 # The order of packages is significant, because pip processes them in the order
2 2
 # of appearance. Changing the order has an impact on the overall integration
3 3
 # process, which may cause wedges in the gate later.
4
-sphinx>=1.6.5,!=1.6.6,!=1.6.7,<2.0.0;python_version=='2.7'  # BSD
5
-sphinx>=1.6.5,!=1.6.6,!=1.6.7;python_version>='3.4'  # BSD
4
+sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
5
+sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
6 6
 openstackdocstheme>=1.20.0 # Apache-2.0
7 7
 reno>=2.7.0 # Apache-2.0
8 8
 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'
73 73
 # [howto/manual]).
74 74
 latex_documents = [
75 75
     ('index',
76
-     '%s.tex' % project,
76
+     'doc-%s.tex' % project,
77 77
      u'%s Documentation' % project,
78 78
      u'OpenStack Foundation', 'manual'),
79 79
 ]
80 80
 
81 81
 # Example configuration for intersphinx: refer to the Python standard library.
82 82
 #intersphinx_mapping = {'http://docs.python.org/': None}
83
+
84
+latex_elements = {
85
+    'makeindex': '',
86
+    'printindex': '',
87
+    'preamble': r'\setcounter{tocdepth}{3}',
88
+}

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

@@ -1,6 +1,38 @@
1
-.. cover title comes from README.rst
1
+==========================
2
+Welcome to networking-odl!
3
+==========================
2 4
 
3
-.. include:: ../../README.rst
5
+.. Team and repository tags
6
+.. only:: html
7
+
8
+   .. image:: http://governance.openstack.org/badges/networking-odl.svg
9
+       :target: http://governance.openstack.org/reference/tags/index.html
10
+
11
+Summary
12
+-------
13
+
14
+OpenStack networking-odl is a library of drivers and plugins that integrates
15
+OpenStack Neutron API with OpenDaylight Backend. For example it has ML2
16
+driver and L3 plugin to enable communication of OpenStack Neutron L2
17
+and L3 resources API to OpenDayLight Backend.
18
+
19
+To report and discover bugs in networking-odl the following
20
+link can be used:
21
+https://bugs.launchpad.net/networking-odl
22
+
23
+Any new code submission or proposal must follow the development
24
+guidelines detailed in HACKING.rst and for further details this
25
+link can be checked:
26
+https://docs.openstack.org/networking-odl/latest/
27
+
28
+The OpenDaylight homepage:
29
+https://www.opendaylight.org/
30
+
31
+Release notes for the project can be found at:
32
+https://docs.openstack.org/releasenotes/networking-odl/
33
+
34
+The project source code repository is located at:
35
+https://opendev.org/openstack/networking-odl
4 36
 
5 37
 Installation
6 38
 ------------
@@ -37,9 +69,11 @@ Reference Deployment Guide
37 69
 
38 70
    reference/index
39 71
 
40
-Indices and tables
41
-------------------
72
+.. only:: html
73
+
74
+   Indices and tables
75
+   ------------------
42 76
 
43
-* :ref:`genindex`
44
-* :ref:`search`
77
+   * :ref:`genindex`
78
+   * :ref:`search`
45 79
 

+ 10
- 0
tox.ini View File

@@ -92,6 +92,16 @@ commands =
92 92
   rm -rf doc/build
93 93
   sphinx-build -W -b html doc/source doc/build/html
94 94
 
95
+[testenv:pdf-docs]
96
+basepython = python3
97
+envdir = {toxworkdir}/docs
98
+deps = {[testenv:docs]deps}
99
+whitelist_externals =
100
+  make
101
+commands =
102
+  sphinx-build -W -b latex doc/source doc/build/pdf
103
+  make -C doc/build/pdf
104
+
95 105
 [testenv:debug]
96 106
 basepython = python3
97 107
 # Uses default base python

Loading…
Cancel
Save