diff options
| author | Mark Goddard <mark@stackhpc.com> | 2019-09-17 11:50:41 +0100 |
|---|---|---|
| committer | Mark Goddard <mark@stackhpc.com> | 2019-09-17 14:14:18 +0100 |
| commit | ef3abc455f3b133184d26330e3a7fe82d1c521ce (patch) | |
| tree | 68b08ee5b8fb5ebe9186c98b0c4e830bb5d8e7d2 /doc | |
| parent | 8722c78763efa7b9c9c0fb3c20599f1f6f0d69e5 (diff) | |
| download | kolla-ansible-ef3abc455f3b133184d26330e3a7fe82d1c521ce.tar.gz kolla-ansible-ef3abc455f3b133184d26330e3a7fe82d1c521ce.zip | |
Build pdf doc
The is one of community goals that each project should 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: Ia0f8b73bcbda6295319f5c8de1aa02a40844207b
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/requirements.txt | 1 | ||||
| -rw-r--r-- | doc/source/conf.py | 6 |
2 files changed, 6 insertions, 1 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index 0358b58e6..47988d658 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -9,3 +9,4 @@ openstackdocstheme>=1.19.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0 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,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD +sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index f30ac88ea..e5dd3f98e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -24,6 +24,7 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'openstackdocstheme', 'sphinx.ext.autodoc', + 'sphinxcontrib.rsvgconverter', ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -79,11 +80,14 @@ html_last_updated_fmt = '%Y-%m-%d %H:%M' # [howto/manual]). latex_documents = [ ('index', - '%s.tex' % project, + 'doc-%s.tex' % project, u'%s Documentation' % project, u'OpenStack Foundation', 'manual'), ] +# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664 +latex_use_xindy = False + # openstackdocstheme options repository_name = 'openstack/kolla-ansible' bug_project = 'kolla-ansible' |