Browse code
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
Masayuki Igawa authored on 2019/09/25 12:23:16Showing 3 changed files
| ... | ... |
@@ -165,7 +165,7 @@ htmlhelp_basename = 'DevStack-doc' |
| 165 | 165 |
# Grouping the document tree into LaTeX files. List of tuples |
| 166 | 166 |
# (source start file, target name, title, author, documentclass [howto/manual]). |
| 167 | 167 |
latex_documents = [ |
| 168 |
- ('index', 'DevStack-doc.tex', u'DevStack Docs',
|
|
| 168 |
+ ('index', 'doc-devstack.tex', u'DevStack Docs',
|
|
| 169 | 169 |
u'OpenStack DevStack Team', 'manual'), |
| 170 | 170 |
] |
| 171 | 171 |
|
| ... | ... |
@@ -11,9 +11,8 @@ |
| 11 | 11 |
and how to go beyond this setup. Both should be a set of quick |
| 12 | 12 |
links to other documents to let people explore from there. |
| 13 | 13 |
|
| 14 |
-========== |
|
| 15 |
- DevStack |
|
| 16 |
-========== |
|
| 14 |
+DevStack |
|
| 15 |
+======== |
|
| 17 | 16 |
|
| 18 | 17 |
.. image:: assets/images/logo-blue.png |
| 19 | 18 |
|
| ... | ... |
@@ -32,7 +31,7 @@ The source is available at `<https://opendev.org/openstack/devstack>`__. |
| 32 | 32 |
are dedicated to this purpose. |
| 33 | 33 |
|
| 34 | 34 |
Quick Start |
| 35 |
-=========== |
|
| 36 | 35 |
|
| 37 | 36 |
Install Linux |
| 38 | 37 |
------------- |
| ... | ... |
@@ -153,7 +152,7 @@ with devstack, and help us by :doc:`contributing to the project |
| 153 | 153 |
<hacking>`. |
| 154 | 154 |
|
| 155 | 155 |
Contents |
| 156 | 156 |
|
| 157 | 157 |
.. toctree:: |
| 158 | 158 |
:glob: |
| ... | ... |
@@ -43,6 +43,14 @@ setenv = |
| 43 | 43 |
commands = |
| 44 | 44 |
sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html |
| 45 | 45 |
|
| 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 |
|
| 46 | 54 |
|
| 47 | 55 |
[testenv:venv] |
| 48 | 56 |
basepython = python3 |