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
This commit is contained in:
parent
e3cd502252
commit
12e5ddcc2d
@ -165,7 +165,7 @@ htmlhelp_basename = 'DevStack-doc'
|
|||||||
# Grouping the document tree into LaTeX files. List of tuples
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
# (source start file, target name, title, author, documentclass [howto/manual]).
|
# (source start file, target name, title, author, documentclass [howto/manual]).
|
||||||
latex_documents = [
|
latex_documents = [
|
||||||
('index', 'DevStack-doc.tex', u'DevStack Docs',
|
('index', 'doc-devstack.tex', u'DevStack Docs',
|
||||||
u'OpenStack DevStack Team', 'manual'),
|
u'OpenStack DevStack Team', 'manual'),
|
||||||
]
|
]
|
||||||
|
|
||||||
|
@ -11,9 +11,8 @@
|
|||||||
and how to go beyond this setup. Both should be a set of quick
|
and how to go beyond this setup. Both should be a set of quick
|
||||||
links to other documents to let people explore from there.
|
links to other documents to let people explore from there.
|
||||||
|
|
||||||
==========
|
|
||||||
DevStack
|
DevStack
|
||||||
==========
|
========
|
||||||
|
|
||||||
.. image:: assets/images/logo-blue.png
|
.. image:: assets/images/logo-blue.png
|
||||||
|
|
||||||
@ -32,7 +31,7 @@ The source is available at `<https://opendev.org/openstack/devstack>`__.
|
|||||||
are dedicated to this purpose.
|
are dedicated to this purpose.
|
||||||
|
|
||||||
Quick Start
|
Quick Start
|
||||||
===========
|
+++++++++++
|
||||||
|
|
||||||
Install Linux
|
Install Linux
|
||||||
-------------
|
-------------
|
||||||
@ -153,7 +152,7 @@ with devstack, and help us by :doc:`contributing to the project
|
|||||||
<hacking>`.
|
<hacking>`.
|
||||||
|
|
||||||
Contents
|
Contents
|
||||||
--------
|
++++++++
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:glob:
|
:glob:
|
||||||
|
8
tox.ini
8
tox.ini
@ -43,6 +43,14 @@ setenv =
|
|||||||
commands =
|
commands =
|
||||||
sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
|
sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
|
||||||
|
|
||||||
|
[testenv:pdf-docs]
|
||||||
|
basepython = python3
|
||||||
|
deps = {[testenv:docs]deps}
|
||||||
|
whitelist_externals =
|
||||||
|
make
|
||||||
|
commands =
|
||||||
|
sphinx-build -W -b latex doc/source doc/build/pdf
|
||||||
|
make -C doc/build/pdf
|
||||||
|
|
||||||
[testenv:venv]
|
[testenv:venv]
|
||||||
basepython = python3
|
basepython = python3
|
||||||
|
Loading…
Reference in New Issue
Block a user