Build PDF docs
This commit adds a new tox target to build PDF documentation. It's a community goal[0] to have PDF docs available. Update conf.py for latex building. [0] https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html Co-authored-by: Bogdan Dobrelya <bdobreli@redhat.com> Change-Id: I411bdabeaf70164ec1020abc2d22fcf1764f7c02
This commit is contained in:
parent
ca780d3bb8
commit
363852f80d
@ -7,3 +7,4 @@ docutils>=0.11 # OSI-Approved Open Source, Public Domain
|
||||
openstackdocstheme>=1.18.1 # Apache-2.0
|
||||
beautifulsoup4>=4.6.0 # MIT
|
||||
reno>=2.5.0 # Apache-2.0
|
||||
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
|
||||
|
@ -27,6 +27,7 @@ sys.path.insert(0, os.path.abspath('.'))
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'openstackdocstheme',
|
||||
'sphinxcontrib.rsvgconverter',
|
||||
'enforcer'
|
||||
]
|
||||
|
||||
@ -107,13 +108,16 @@ htmlhelp_basename = '%sdoc' % project
|
||||
# [howto/manual]).
|
||||
latex_documents = [
|
||||
('index',
|
||||
'%s.tex' % project,
|
||||
u'%s Documentation' % project,
|
||||
'doc-openstacksdk.tex',
|
||||
u'OpenStackSDK Documentation',
|
||||
u'OpenStack Foundation', 'manual'),
|
||||
]
|
||||
|
||||
# Allow deeper levels of nesting for \begin...\end stanzas
|
||||
latex_elements = {'maxlistdepth': 10}
|
||||
|
||||
# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
|
||||
latex_use_xindy = False
|
||||
|
||||
# Include both the class and __init__ docstrings when describing the class
|
||||
autoclass_content = "both"
|
||||
|
11
tox.ini
11
tox.ini
@ -81,7 +81,16 @@ deps =
|
||||
-c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt}
|
||||
-r{toxinidir}/requirements.txt
|
||||
-r{toxinidir}/doc/requirements.txt
|
||||
commands = sphinx-build -W -d doc/build/doctrees -b html doc/source/ doc/build/html
|
||||
commands =
|
||||
sphinx-build -W -d doc/build/doctrees -b html doc/source/ doc/build/html
|
||||
|
||||
[testenv:pdf-docs]
|
||||
deps = {[testenv:docs]deps}
|
||||
whitelist_externals =
|
||||
make
|
||||
commands =
|
||||
sphinx-build -W -d doc/build/doctrees -b latex doc/source/ doc/build/pdf
|
||||
make -C doc/build/pdf
|
||||
|
||||
[testenv:releasenotes]
|
||||
deps =
|
||||
|
Loading…
x
Reference in New Issue
Block a user