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: I8b42ab0f057cb33c1ec93adfa32c45aafc2730b0
This commit is contained in:
parent
04d9ebf605
commit
aa44aadb72
@ -26,7 +26,6 @@ source_suffix = '.rst'
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'Ironic Lib'
|
||||
copyright = u'OpenStack Foundation'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
@ -64,15 +63,12 @@ html_theme = 'openstackdocs'
|
||||
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack/ironic-lib'
|
||||
bug_project = 'ironic-lib'
|
||||
bug_tag = ''
|
||||
|
||||
# Must set this variable to include year, month, day, hours, and minutes.
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
use_storyboard = True
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = '%sdoc' % project
|
||||
htmlhelp_basename = 'ironic-libdoc'
|
||||
|
||||
latex_use_xindy = False
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title, author, documentclass
|
||||
@ -80,8 +76,8 @@ htmlhelp_basename = '%sdoc' % project
|
||||
latex_documents = [
|
||||
(
|
||||
'index',
|
||||
'%s.tex' % project,
|
||||
u'%s Documentation' % project,
|
||||
'doc-ironic-lib.tex',
|
||||
u'Ironic Lib Documentation',
|
||||
u'OpenStack Foundation',
|
||||
'manual'
|
||||
),
|
||||
|
@ -29,7 +29,7 @@ mox3==0.20.0
|
||||
msgpack-python==0.4.0
|
||||
netaddr==0.7.18
|
||||
netifaces==0.10.4
|
||||
openstackdocstheme==1.18.1
|
||||
openstackdocstheme==1.20.0
|
||||
os-client-config==1.28.0
|
||||
os-testr==1.0.0
|
||||
oslo.concurrency==3.26.0
|
||||
|
@ -16,4 +16,4 @@ testtools>=2.2.0 # MIT
|
||||
doc8>=0.6.0 # Apache-2.0
|
||||
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,>=1.6.2;python_version>='3.4' # BSD
|
||||
openstackdocstheme>=1.18.1 # Apache-2.0
|
||||
openstackdocstheme>=1.20.0 # Apache-2.0
|
||||
|
9
tox.ini
9
tox.ini
@ -60,6 +60,15 @@ envdir = {toxworkdir}/venv
|
||||
commands =
|
||||
python setup.py build_sphinx
|
||||
|
||||
[testenv:pdf-docs]
|
||||
whitelist_externals = make
|
||||
basepython = python3
|
||||
setenv = PYTHONHASHSEED=0
|
||||
sitepackages = False
|
||||
envdir = {toxworkdir}/venv
|
||||
commands = sphinx-build -b latex doc/source doc/build/pdf
|
||||
make -C doc/build/pdf
|
||||
|
||||
[testenv:lower-constraints]
|
||||
basepython = python3
|
||||
deps =
|
||||
|
Loading…
Reference in New Issue
Block a user