Browse Source

Merge "Build pdf doc"

master
Zuul 1 week ago
parent
commit
4de9627b99
3 changed files with 17 additions and 5 deletions
  1. 1
    1
      doc/requirements.txt
  2. 5
    4
      doc/source/conf.py
  3. 11
    0
      tox.ini

+ 1
- 1
doc/requirements.txt View File

@@ -6,4 +6,4 @@ sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
6 6
 sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
7 7
 sphinxcontrib-pecanwsme>=0.8.0 # Apache-2.0
8 8
 sphinxcontrib-seqdiag>=0.8.4 # BSD
9
-openstackdocstheme>=1.18.1 # Apache-2.0
9
+openstackdocstheme>=1.20.0 # Apache-2.0

+ 5
- 4
doc/source/conf.py View File

@@ -40,7 +40,6 @@ source_suffix = '.rst'
40 40
 master_doc = 'index'
41 41
 
42 42
 # General information about the project.
43
-project = u'Networking Generic Switch'
44 43
 copyright = u'2017, Openstack Foundation'
45 44
 
46 45
 # If true, '()' will be appended to :func: etc. cross-reference text.
@@ -62,15 +61,17 @@ pygments_style = 'sphinx'
62 61
 html_theme = 'openstackdocs'
63 62
 
64 63
 # Output file base name for HTML help builder.
65
-htmlhelp_basename = '%sdoc' % project
64
+htmlhelp_basename = 'networking-generic-switchdoc'
65
+
66
+latex_use_xindy = False
66 67
 
67 68
 # Grouping the document tree into LaTeX files. List of tuples
68 69
 # (source start file, target name, title, author, documentclass
69 70
 # [howto/manual]).
70 71
 latex_documents = [
71 72
     ('index',
72
-     '%s.tex' % project,
73
-     u'%s Documentation' % project,
73
+     'doc-networking-generic-switch.tex',
74
+     u'Networking Generic Switch Documentation',
74 75
      u'OpenStack Foundation', 'manual'),
75 76
 ]
76 77
 

+ 11
- 0
tox.ini View File

@@ -42,6 +42,17 @@ deps =
42 42
 commands =
43 43
   python setup.py build_sphinx
44 44
 
45
+[testenv:pdf-docs]
46
+basepython = python3
47
+whitelist_externals = make
48
+setenv = PYTHONHASHSEED=0
49
+sitepackages = False
50
+envdir = {toxworkdir}/venv
51
+deps = {[testenv:docs]deps}
52
+commands =
53
+  sphinx-build -b latex doc/source doc/build/pdf
54
+  make -C doc/build/pdf
55
+
45 56
 [testenv:releasenotes]
46 57
 basepython = python3
47 58
 deps =

Loading…
Cancel
Save