summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorVishakha Agarwal <agarwalvishakha18@gmail.com>2019-09-16 01:30:52 +0530
committerVishakha Agarwal <agarwalvishakha18@gmail.com>2019-09-27 17:43:03 +0000
commit381e81cfb24944ee1ebd8636af58d9bf6c35e76d (patch)
tree5690ab6b29488d84a0c599e8fec288770b980cfd /doc
parentd1bd783a77e5b6ae057ba9b13833ff0584e1589b (diff)
downloadkeystonemiddleware-381e81cfb24944ee1ebd8636af58d9bf6c35e76d.tar.gz
Generate pdf documentation
Change-Id: I4bc8c036ce91795129970ab4f8c2536401c2a135
Diffstat (limited to 'doc')
-rw-r--r--doc/requirements.txt3
-rw-r--r--doc/source/conf.py19
2 files changed, 19 insertions, 3 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 42dda5b..ddd05be 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -10,6 +10,9 @@ 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
sphinxcontrib-apidoc>=0.2.0 # BSD
+# PDF Docs
+sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
+
# For autodoc builds
mock>=2.0.0 # BSD
oslotest>=3.2.0 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index ccea01f..4428242 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -42,6 +42,7 @@ extensions = ['sphinx.ext.todo',
'openstackdocstheme',
'oslo_config.sphinxconfiggen',
'sphinxcontrib.apidoc',
+ 'sphinxcontrib.rsvgconverter',
]
# sphinxcontrib.apidoc options
@@ -200,12 +201,24 @@ htmlhelp_basename = 'keystonemiddlewaredoc'
# (source start file, target name, title, author, documentclass [howto/manual])
# .
latex_documents = [
- ('index', 'keystonmiddleware.tex',
- 'keystonemiddleware Documentation',
- 'Nebula Inc, based on work by Rackspace and Jacob Kaplan-Moss',
+ ('index', 'doc-keystonemiddleware.tex',
+ u'keystonemiddleware Documentation',
+ u'Openstack Developers',
'manual'),
]
+# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
+latex_use_xindy = False
+
+latex_domain_indices = False
+
+latex_elements = {
+ 'extraclassoptions': 'openany',
+ 'makeindex': '',
+ 'printindex': '',
+ 'preamble': r'\setcounter{tocdepth}{3}',
+ 'maxlistdepth': 10,
+}
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None