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: I07d08bb2c5ea351dc2ad697c5889bd97d04f7c7c
This commit is contained in:
Kaifeng Wang 2019-06-20 15:23:15 +08:00
parent 157b396ae7
commit 0812b1eb07
4 changed files with 15 additions and 6 deletions

View File

@ -26,6 +26,10 @@ extensions = [
'openstackdocstheme',
]
# openstackdocstheme options
repository_name = 'openstack/sushy-tools'
use_storyboard = True
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
# execute "export SPHINX_DEBUG=1" in your terminal to disable
@ -37,7 +41,6 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'sushy-tools'
copyright = u'2016, OpenStack Foundation'
# If true, '()' will be appended to :func: etc. cross-reference text.
@ -60,15 +63,15 @@ pygments_style = 'sphinx'
html_theme = 'openstackdocs'
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
htmlhelp_basename = 'sushy-toolsdoc'
# 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-tools.tex',
u'Sushy Tools Documentation',
u'OpenStack Foundation', 'manual'),
]

View File

@ -24,7 +24,7 @@ MarkupSafe==1.0
mock==2.0.0
mox3==0.20.0
munch==2.1.0
openstackdocstheme==1.18.1
openstackdocstheme==1.20.0
openstacksdk===0.11.2
oslotest==3.2.0
pbr==2.0.0

View File

@ -10,7 +10,7 @@ libvirt-python!=4.1.0,>=3.7.0 # LGPLv2+
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
# used by nova driver
openstacksdk>=0.11.2 # Apache-2.0
oslotest>=3.2.0 # Apache-2.0

View File

@ -39,6 +39,12 @@ commands =
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 =