Skip to content

Commit 12e5ddc

Browse files
committed
Add PDF documentation build
This commit adds PDF documentation build target 'pdf-docs' that will build PDF versions of our docs. As per the Train community goal: https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html Change-Id: Iecb0fe5b957af7dae66bea04dfbd9c2fb4f74a99 Story: #2006070 Task: #35456
1 parent e3cd502 commit 12e5ddc

3 files changed

Lines changed: 13 additions & 6 deletions

File tree

doc/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@
165165
# Grouping the document tree into LaTeX files. List of tuples
166166
# (source start file, target name, title, author, documentclass [howto/manual]).
167167
latex_documents = [
168-
('index', 'DevStack-doc.tex', u'DevStack Docs',
168+
('index', 'doc-devstack.tex', u'DevStack Docs',
169169
u'OpenStack DevStack Team', 'manual'),
170170
]
171171

doc/source/index.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,8 @@
1111
and how to go beyond this setup. Both should be a set of quick
1212
links to other documents to let people explore from there.
1313
14-
==========
15-
DevStack
16-
==========
14+
DevStack
15+
========
1716

1817
.. image:: assets/images/logo-blue.png
1918

@@ -32,7 +31,7 @@ The source is available at `<https://opendev.org/openstack/devstack>`__.
3231
are dedicated to this purpose.
3332

3433
Quick Start
35-
===========
34+
+++++++++++
3635

3736
Install Linux
3837
-------------
@@ -153,7 +152,7 @@ with devstack, and help us by :doc:`contributing to the project
153152
<hacking>`.
154153

155154
Contents
156-
--------
155+
++++++++
157156

158157
.. toctree::
159158
:glob:

tox.ini

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,14 @@ setenv =
4343
commands =
4444
sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
4545

46+
[testenv:pdf-docs]
47+
basepython = python3
48+
deps = {[testenv:docs]deps}
49+
whitelist_externals =
50+
make
51+
commands =
52+
sphinx-build -W -b latex doc/source doc/build/pdf
53+
make -C doc/build/pdf
4654

4755
[testenv:venv]
4856
basepython = python3

0 commit comments

Comments
 (0)