PDF Documentation Build tox target

This patch adds a `pdf-docs` tox target 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

Add sphinxcontrib-svg2pdfconverter to doc/requirements.txt
to convert our SVGs.

Change-Id: Ib0fc3cabe19771c3f569d22c8b09aa456f4caf6e
Story: 2006105
This commit is contained in:
Dmitriy Rabotyagov 2019-10-15 22:39:01 +03:00
parent 7bde578d9b
commit 8e13d0d014
4 changed files with 29 additions and 8 deletions

View File

@ -10,7 +10,8 @@
# automatically be proposed to all the repositories which use it. # automatically be proposed to all the repositories which use it.
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,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD sphinx>=1.8.0,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
openstackdocstheme>=1.20.0 # Apache-2.0 sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
openstackdocstheme>=1.18.1 # Apache-2.0
reno>=2.5.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0
doc8>=0.6.0 # Apache-2.0 doc8>=0.6.0 # Apache-2.0

View File

View File

@ -40,6 +40,7 @@ import pbr.version
extensions = [ extensions = [
'openstackdocstheme', 'openstackdocstheme',
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'sphinxcontrib.rsvgconverter',
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
@ -62,8 +63,8 @@ category = 'Miscellaneous'
copyright = '2014-2016, OpenStack-Ansible Contributors' copyright = '2014-2016, OpenStack-Ansible Contributors'
description = 'OpenStack-Ansible deploys OpenStack environments using Ansible.' description = 'OpenStack-Ansible deploys OpenStack environments using Ansible.'
project = 'OpenStack-Ansible' project = 'OpenStack-Ansible'
role_name = 'ansible-role-python_venv_build' role_name = 'python_venv_build'
target_name = 'openstack-ansible-' + role_name target_name = 'ansible-role-' + role_name
title = 'OpenStack-Ansible Documentation: ' + role_name + ' role' title = 'OpenStack-Ansible Documentation: ' + role_name + ' role'
# The link to the browsable source code (for the left hand menu) # The link to the browsable source code (for the left hand menu)
@ -250,10 +251,12 @@ latex_elements = {
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
(master_doc, target_name + '.tex', (master_doc, 'doc-' + target_name + '.tex',
title, author, 'manual'), title.replace("_", "\_"), author, 'manual'),
] ]
latex_use_xindy = False
# The name of an image file (relative to this directory) to place at the top of # The name of an image file (relative to this directory) to place at the top of
# the title page. # the title page.
# latex_logo = None # latex_logo = None
@ -310,3 +313,10 @@ texinfo_documents = [
# If true, do not generate a @detailmenu in the "Top" node's menu. # If true, do not generate a @detailmenu in the "Top" node's menu.
# texinfo_no_detailmenu = False # texinfo_no_detailmenu = False
pdf_documents = [
(master_doc, target_name,
title, author)
]
locale_dirs = ['locale/']

10
tox.ini
View File

@ -42,6 +42,16 @@ commands=
sphinx-build -b html doc/source doc/build/html sphinx-build -b html 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
[doc8] [doc8]
# Settings for doc8: # Settings for doc8:
extensions = .rst extensions = .rst