dd02f75d56
The is one of community goals that each project could produce a single PDF file. The pdf should be in the output of openstack-tox-docs job. The list of changes: - add a new pdf-docs environment to enable PDF build, - sphinxcontrib-svg2pdfconverter is used to handle SVG properly, - poke versions for sphinx and openstackdocstheme, - disable usage of xindy for tex, - do not generate empty pages, - only build html for toctree and other content-less for pdf sections, - adjust README to firstly contain "About tripleo" then team & repo tags for the better view in PDF-generated contents. - move the Contributing chapter closer to the beginning for the better view in the long list of generated contents. 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 TeX and few more packages may be needed to build PDF locally (listed for bindep): inkscape [doc platform:dpkg] fonts-liberation [doc platform:dpkg] texlive-latex-base [doc platform:dpkg] texlive-latex-extra [doc platform:dpkg] texlive-xetex [doc platform:dpkg] texlive-fonts-recommended [doc platform:dpkg] xindy [doc platform:dpkg] latexmk [doc platform:dpkg] texlive [doc platform:rpm] texlive-fncychap [doc platform:rpm] texlive-titlesec [doc platform:rpm] texlive-tabulary [doc platform:rpm] texlive-framed [doc platform:rpm] texlive-wrapfig [doc platform:rpm] texlive-upquote [doc platform:rpm] texlive-capt-of [doc platform:rpm] texlive-needspace [doc platform:rpm] texlive-polyglossia [doc platform:rpm] latexmk [doc platform:rpm] python3-sphinxcontrib-svg2pdfconverter-common [doc platform:rpm] librsvg2-tools [doc platform:rpm] librsvg2-bin [doc platform:dpkg] Change-Id: Ib3bb34191582f581c28f2f8a0281cf3ae44003e8 Signed-off-by: Bogdan Dobrelya <bdobreli@redhat.com>
88 lines
2.8 KiB
Python
88 lines
2.8 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
# implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import os, sys
|
|
|
|
sys.path.insert(0, os.path.abspath('../..'))
|
|
# -- General configuration ----------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'openstackdocstheme',
|
|
'cliff.sphinxext',
|
|
'sphinxcontrib.rsvgconverter',
|
|
]
|
|
|
|
# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
|
|
latex_use_xindy = False
|
|
|
|
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
|
# text edit cycles.
|
|
# execute "export SPHINX_DEBUG=1" in your terminal to disable
|
|
|
|
# The suffix of source filenames.
|
|
source_suffix = '.rst'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
copyright = u'2017 Red Hat, Inc.'
|
|
|
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
|
add_function_parentheses = True
|
|
|
|
# If true, the current module name will be prepended to all description
|
|
# unit titles (such as .. function::).
|
|
add_module_names = True
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'sphinx'
|
|
|
|
suppress_warnings = ['image.nonlocal_uri']
|
|
|
|
# -- Options for HTML output --------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
|
# Sphinx are currently 'default' and 'sphinxdoc'.
|
|
# html_theme_path = ["."]
|
|
html_theme = 'openstackdocs'
|
|
# html_static_path = ['static']
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = 'tripleoclientdoc'
|
|
|
|
# Grouping the document tree into LaTeX files. List of tuples
|
|
# (source start file, target name, title, author, documentclass
|
|
# [howto/manual]).
|
|
latex_documents = [
|
|
('index',
|
|
'doc-python-tripleoclient.tex',
|
|
u'Tripleoclient Documentation',
|
|
u'OpenStack Foundation', 'manual'),
|
|
]
|
|
|
|
# Allow deeper levels of nesting for \begin...\end stanzas
|
|
latex_elements = {'maxlistdepth': 10, 'extraclassoptions': ',openany,oneside'}
|
|
|
|
# openstackdocstheme options
|
|
repository_name = 'openstack/python-tripleoclient'
|
|
bug_project = 'python-tripleoclient'
|
|
bug_tag = ''
|
|
|
|
# Last updated timestamp
|
|
autoprogram_cliff_application = 'openstack'
|