Build pdf doc
The is one of community goals that each project could produce a single PDF file. The pdf should be in the output of openstack-tox-docs job. TeX packages are required to build PDF locally, following is recommended: * inkscape * texlive-latex-base * texlive-latex-extra * texlive-fonts-recommended More about the goal: https://governance.openstack.org/tc/goals/train/pdf-doc-generation.html https://etherpad.openstack.org/p/train-pdf-support-goal https://etherpad.openstack.org/p/pdf-goal-train-common-problems Change-Id: If5446ce4ceee7e38a0052503aa8fc2b6c5d7de66
This commit is contained in:
parent
5271064c76
commit
cef3bac3dc
@ -61,6 +61,7 @@ bug_tag = ''
|
|||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = 'Ironic Python Agentdoc'
|
htmlhelp_basename = 'Ironic Python Agentdoc'
|
||||||
|
|
||||||
|
latex_use_xindy = False
|
||||||
|
|
||||||
# Grouping the document tree into LaTeX files. List of tuples
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
# (source start file, target name, title, author, documentclass
|
# (source start file, target name, title, author, documentclass
|
||||||
@ -68,7 +69,7 @@ htmlhelp_basename = 'Ironic Python Agentdoc'
|
|||||||
latex_documents = [
|
latex_documents = [
|
||||||
(
|
(
|
||||||
'index',
|
'index',
|
||||||
'Ironic Python Agent.tex',
|
'doc-ironic-python-agent.tex',
|
||||||
u'Ironic Python Agent Documentation',
|
u'Ironic Python Agent Documentation',
|
||||||
u'OpenStack Foundation',
|
u'OpenStack Foundation',
|
||||||
'manual'
|
'manual'
|
||||||
|
9
tox.ini
9
tox.ini
@ -71,6 +71,15 @@ sitepackages = False
|
|||||||
commands =
|
commands =
|
||||||
python setup.py build_sphinx
|
python setup.py build_sphinx
|
||||||
|
|
||||||
|
[testenv:pdf-docs]
|
||||||
|
basepython = python3
|
||||||
|
whitelist_externals = make
|
||||||
|
setenv = PYTHONHASHSEED=0
|
||||||
|
sitepackages = False
|
||||||
|
commands =
|
||||||
|
sphinx-build -b latex doc/source doc/build/pdf
|
||||||
|
make -C doc/build/pdf
|
||||||
|
|
||||||
[testenv:releasenotes]
|
[testenv:releasenotes]
|
||||||
basepython = python3
|
basepython = python3
|
||||||
commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
|
commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
|
||||||
|
Loading…
x
Reference in New Issue
Block a user