Add PDF generation support for Searchlight

Change-Id: I03d5ff8e9585b05fd3a5095ec08ec8b6d5a6257b
Signed-off-by: Trinh Nguyen <dangtrinhnt@gmail.com>
Story: #2006118
Task: #35499
This commit is contained in:
Trinh Nguyen 2019-09-26 23:34:05 +09:00
parent 2e4c3bdb74
commit c8738b8ae1
3 changed files with 28 additions and 5 deletions

View File

@ -1,6 +1,7 @@
# Documentation
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
openstackdocstheme>=1.18.1 # Apache-2.0
openstackdocstheme>=1.30.0 # Apache-2.0
os-api-ref>=1.4.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD

View File

@ -1,4 +1,3 @@
# -*- coding: utf-8 -*-
# Copyright (c) 2010 OpenStack Foundation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
@ -49,6 +48,7 @@ extensions = ['sphinx.ext.coverage',
'openstackdocstheme',
'oslo_policy.sphinxext',
'oslo_policy.sphinxpolicygen',
'sphinxcontrib.rsvgconverter',
]
# Add any paths that contain templates here, relative to this directory.
@ -220,12 +220,24 @@ htmlhelp_basename = 'searchlightdoc'
# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
latex_use_xindy = False
latex_domain_indices = False
latex_elements = {
'makeindex': '',
'printindex': '',
'preamble': r'\setcounter{tocdepth}{3}',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author,
# documentclass [howto/manual]).
latex_documents = [
('index', 'Searchlight.tex', u'Searchlight Documentation',
u'Searchlight Team', 'manual'),
('index',
'doc-Searchlight.tex',
u'Searchlight Documentation',
u'Searchlight Team', 'manual', True),
]
# The name of an image file (relative to this directory) to place at the top of

12
tox.ini
View File

@ -52,7 +52,17 @@ deps = -r{toxinidir}/doc/requirements.txt
whitelist_externals = rm
commands =
rm -rf doc/build
sphinx-build -W -b html 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 = -r{toxinidir}/doc/requirements.txt
envdir = {toxworkdir}/docs
whitelist_externals =
make
commands =
sphinx-build -W -b latex doc/source doc/build/pdf
make -C doc/build/pdf
[testenv:api-ref]
basepython = python3