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: Iadbfcb0ab746ac0a64abc85ae7ea2f628405f6fb
This commit is contained in:
Kaifeng Wang 2019-06-14 17:34:30 +08:00
parent c209cb805a
commit ae2bafb37f
4 changed files with 13 additions and 6 deletions

View File

@ -36,7 +36,6 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'sushy'
copyright = u'2016, OpenStack Foundation'
# If true, '()' will be appended to :func: etc. cross-reference text.
@ -58,15 +57,17 @@ html_theme = 'openstackdocs'
# html_static_path = ['static']
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
htmlhelp_basename = 'sushydoc'
latex_use_xindy = False
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index',
'%s.tex' % project,
u'%s Documentation' % project,
'doc-sushy.tex',
u'Sushy Documentation',
u'OpenStack Foundation', 'manual'),
]

View File

@ -17,7 +17,7 @@ MarkupSafe==1.0
mccabe==0.2.1
mock==2.0.0
mox3==0.20.0
openstackdocstheme==1.18.1
openstackdocstheme==1.20.0
os-client-config==1.28.0
oslotest==3.2.0
pbr==2.0.0

View File

@ -8,7 +8,7 @@ coverage!=4.4,>=4.0 # Apache-2.0
python-subunit>=1.0.0 # Apache-2.0/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
openstackdocstheme>=1.18.1 # Apache-2.0
openstackdocstheme>=1.20.0 # Apache-2.0
oslotest>=3.2.0 # Apache-2.0
stestr>=2.0.0 # Apache-2.0
testscenarios>=0.4 # Apache-2.0/BSD

View File

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