openstack/keystonemiddleware
Code Issues Proposed changes

Generate pdf documentation

Browse Source 
Change-Id: I4bc8c036ce91795129970ab4f8c2536401c2a135
This commit is contained in:
Vishakha Agarwal 2019-09-16 01:30:52 +05:30
parent d1bd783a77
commit 381e81cfb2
3 changed files with 31 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/requirements.txt
View File

@ -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 sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
sphinxcontrib-apidoc>=0.2.0 # BSD sphinxcontrib-apidoc>=0.2.0 # BSD
# PDF Docs
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
# For autodoc builds # For autodoc builds
mock>=2.0.0 # BSD mock>=2.0.0 # BSD
oslotest>=3.2.0 # Apache-2.0 oslotest>=3.2.0 # Apache-2.0

19
doc/source/conf.py
View File

@ -42,6 +42,7 @@ extensions = ['sphinx.ext.todo',
'openstackdocstheme', 'openstackdocstheme',
'oslo_config.sphinxconfiggen', 'oslo_config.sphinxconfiggen',
'sphinxcontrib.apidoc', 'sphinxcontrib.apidoc',
'sphinxcontrib.rsvgconverter',
] ]
# sphinxcontrib.apidoc options # sphinxcontrib.apidoc options
@ -200,12 +201,24 @@ htmlhelp_basename = 'keystonemiddlewaredoc'
# (source start file, target name, title, author, documentclass [howto/manual]) # (source start file, target name, title, author, documentclass [howto/manual])
# . # .
latex_documents = [ latex_documents = [
('index', 'keystonmiddleware.tex', ('index', 'doc-keystonemiddleware.tex',
'keystonemiddleware Documentation', u'keystonemiddleware Documentation',
'Nebula Inc, based on work by Rackspace and Jacob Kaplan-Moss', u'Openstack Developers',
'manual'), '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 name of an image file (relative to this directory) to place at the top of
# the title page. # the title page.
#latex_logo = None #latex_logo = None

12
tox.ini
View File

@ -64,6 +64,18 @@ commands=
doc8 doc/source doc8 doc/source
sphinx-build -W -b html doc/source doc/build/html 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
rm
commands =
rm -rf doc/build/pdf
sphinx-build -W -b latex doc/source doc/build/pdf
make -C doc/build/pdf
[testenv:releasenotes] [testenv:releasenotes]
basepython = python3 basepython = python3
deps = -r{toxinidir}/doc/requirements.txt deps = -r{toxinidir}/doc/requirements.txt