openstack/ironic-python-agent-builder
Code Issues Proposed changes

Build pdf doc

Browse Source 
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: Ic036194e33224be9341dbde901c4ba4717ccbbc8
This commit is contained in:
Kaifeng Wang 2019-06-17 11:53:01 +08:00
parent 5cdadc54ee
commit cea462b0e4
3 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/conf.py
View File

@ -37,13 +37,11 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'ironic-python-agent-builder'
copyright = u'2017, OpenStack Developers' copyright = u'2017, OpenStack Developers'
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/ironic-python-agent-builder' repository_name = 'openstack/ironic-python-agent-builder'
bug_project = 'ironic-python-agent' use_storyboard = True
bug_tag = ''
# If true, '()' will be appended to :func: etc. cross-reference text. # If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True add_function_parentheses = True
@ -66,14 +64,14 @@ html_theme = 'openstackdocs'
html_last_updated_fmt = '%Y-%m-%d %H:%M' html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project htmlhelp_basename = 'ironic-python-agent-builderdoc'
# 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
# [howto/manual]). # [howto/manual]).
latex_documents = [ latex_documents = [
('index', ('index',
'%s.tex' % project, 'doc-ironic-python-agent-builder.tex',
u'Ironic Python Agent Builder Documentation', u'Ironic Python Agent Builder Documentation',
u'OpenStack Developers', 'manual'), u'OpenStack Developers', 'manual'),
] ]

2
test-requirements.txt
View File

@ -5,6 +5,6 @@
doc8>=0.6.0 # Apache-2.0 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,<2.0.0;python_version=='2.7' # BSD
sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD
openstackdocstheme>=1.17.0 # Apache-2.0 openstackdocstheme>=1.20.0 # Apache-2.0
# releasenotes # releasenotes
reno>=2.5.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0

6
tox.ini
View File

@ -23,6 +23,12 @@ commands = {posargs}
basepython = python3 basepython = python3
commands = python setup.py build_sphinx commands = python setup.py build_sphinx
[testenv:pdf-docs]
whitelist_externals = make
basepython = python3
commands = sphinx-build -b latex doc/source doc/build/pdf
make -C doc/build/pdf
[testenv:releasenotes] [testenv:releasenotes]
basepython = python3 basepython = python3
commands = commands =