PDF documentation build

Change-Id: Ib48ba316d2395fa07fe74ec21e6dc45afd653382
Implements: blueprint pdfdocs
This commit is contained in:
Hongbin Lu 2019-12-08 00:10:59 +00:00
parent d306ed3709
commit e9e5473d15
6 changed files with 60 additions and 28 deletions

View File

@ -78,11 +78,23 @@ htmlhelp_basename = '%sdoc' % project
# [howto/manual]). # [howto/manual]).
latex_documents = [ latex_documents = [
('index', ('index',
'%s.tex' % project, 'doc-%s.tex' % project,
u'%s Documentation' % project, u'Zun Documentation',
u'OpenStack Foundation', 'manual'), u'Zun development team', 'manual'),
] ]
# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
latex_use_xindy = False
latex_domain_indices = False
latex_elements = {
'makeindex': '',
'printindex': '',
'preamble': r'\setcounter{tocdepth}{3}',
'extraclassoptions': 'openany',
}
# Must set this variable to include year, month, day, hours, and minutes. # Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M' html_last_updated_fmt = '%Y-%m-%d %H:%M'

View File

@ -7,6 +7,8 @@ auto-generated from Zun when this documentation is built, so
if you are having issues with an option, please compare your version of if you are having issues with an option, please compare your version of
Zun with the version of this documentation. Zun with the version of this documentation.
.. only:: html
The sample configuration can also be viewed in :download:`file form The sample configuration can also be viewed in :download:`file form
</_static/zun.conf.sample>`. </_static/zun.conf.sample>`.

View File

@ -27,7 +27,11 @@ Launchpad credentials
Creating a login on Launchpad is important even if you don't use the Launchpad Creating a login on Launchpad is important even if you don't use the Launchpad
site itself, since Launchpad credentials are used for logging in on several site itself, since Launchpad credentials are used for logging in on several
OpenStack-related sites. These sites include: OpenStack-related sites.
.. only:: html
These sites include:
* `Wiki`_ * `Wiki`_
* Gerrit (see :doc:`gerrit`) * Gerrit (see :doc:`gerrit`)

View File

@ -78,26 +78,20 @@ Please ensure that you follow their install guides first.
For Contributors For Contributors
================ ================
If you are new to Zun, this should help you quickly setup the development If you are new to Zun, the developer quick-start guide should help you quickly
environment and get started. setup the development environment and get started.
There are also a number of technical references on various topics
collected in contributors guide.
.. toctree:: .. toctree::
:glob: :glob:
:maxdepth: 2 :maxdepth: 2
contributor/quickstart contributor/quickstart
There are also a number of technical references on various topics.
These are collected below.
.. toctree::
:glob:
:maxdepth: 2
contributor/index contributor/index
Reference Material Additional Material
================== ===================
.. toctree:: .. toctree::
:glob: :glob:
@ -107,7 +101,9 @@ Reference Material
admin/index admin/index
configuration/index configuration/index
user/filter-scheduler user/filter-scheduler
reference/api-microversion-history reference/index
.. only:: html
Search Search
====== ======

View File

@ -0,0 +1,8 @@
Reference Material
==================
.. toctree::
:glob:
:maxdepth: 1
api-microversion-history

10
tox.ini
View File

@ -58,6 +58,16 @@ deps = -r{toxinidir}/doc/requirements.txt
commands = commands =
sphinx-build -W -d doc/build/doctrees -b html doc/source/ doc/build/html sphinx-build -W -d doc/build/doctrees -b html doc/source/ doc/build/html
[testenv:pdf-docs]
basepython = python3
envdir = {toxworkdir}/docs
deps = {[testenv:docs]deps}
whitelist_externals =
make
commands =
sphinx-build -W -b latex doc/source doc/build/pdf
make -C doc/build/pdf
[testenv:debug] [testenv:debug]
basepython = python3 basepython = python3
commands = oslo_debug_helper {posargs} commands = oslo_debug_helper {posargs}