Browse Source

Merge "Generate pdf documentation"

tags/3.21.0^0
Zuul 1 week ago
parent
commit
79f150f962
2 changed files with 27 additions and 4 deletions
  1. 15
    4
      doc/source/conf.py
  2. 12
    0
      tox.ini

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

@@ -180,10 +180,9 @@ htmlhelp_basename = 'python-keystoneclientdoc'
180 180
 # (source start file, target name, title, author, documentclass [howto/manual])
181 181
 # .
182 182
 latex_documents = [
183
-    ('index', 'python-keystoneclient.tex',
184
-     'python-keystoneclient Documentation',
185
-     'Nebula Inc, based on work by Rackspace and Jacob Kaplan-Moss',
186
-     'manual'),
183
+    ('index', 'doc-python-keystoneclient.tex',
184
+     u'python-keystoneclient Documentation',
185
+     u'OpenStack', 'manual'),
187 186
 ]
188 187
 
189 188
 # The name of an image file (relative to this directory) to place at the top of
@@ -203,6 +202,18 @@ latex_documents = [
203 202
 # If false, no module index is generated.
204 203
 #latex_use_modindex = True
205 204
 
205
+# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
206
+latex_use_xindy = False
207
+
208
+latex_domain_indices = False
209
+
210
+latex_elements = {
211
+    'makeindex': '',
212
+    'printindex': '',
213
+    'preamble': r'\setcounter{tocdepth}{3}',
214
+    'maxlistdepth': 10,
215
+}
216
+
206 217
 keystoneauth_url = 'https://docs.openstack.org/keystoneauth/latest/'
207 218
 intersphinx_mapping = {
208 219
     'python': ('https://docs.python.org/', None),

+ 12
- 0
tox.ini View File

@@ -71,6 +71,18 @@ basepython = python3
71 71
 commands = python setup.py build_sphinx
72 72
 deps = -r{toxinidir}/doc/requirements.txt
73 73
 
74
+[testenv:pdf-docs]
75
+basepython = python3
76
+envdir = {toxworkdir}/docs
77
+deps = {[testenv:docs]deps}
78
+whitelist_externals =
79
+  make
80
+  rm
81
+commands =
82
+  rm -rf doc/build/pdf
83
+  sphinx-build -W -b latex doc/source doc/build/pdf
84
+  make -C doc/build/pdf
85
+
74 86
 [testenv:releasenotes]
75 87
 basepython = python3
76 88
 commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html

Loading…
Cancel
Save