Generate PDF documentation
For PDFLaTeX, remove the irrelevant parts (contributing, search). Change-Id: I78e2baa51a523ef4e8b76a5f7b2ad5cda1085b8a Co-Authored-By: Radosław Piliszek <radoslaw.piliszek@gmail.com>
This commit is contained in:

committed by
Radosław Piliszek

parent
5299d5fab4
commit
80ee534f40
@@ -27,6 +27,11 @@ extensions = [
|
||||
'oslo_config.sphinxext',
|
||||
]
|
||||
|
||||
# sphinxcontrib.apidoc options
|
||||
config_generator_config_file = (
|
||||
'../../etc/masakarimonitors/masakarimonitors-config-generator.conf')
|
||||
sample_config_basename = '_static/masakarimonitors'
|
||||
|
||||
# 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
|
||||
@@ -65,20 +70,20 @@ openstackdocs_bug_project = 'masakari-monitors'
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = '%sdoc' % project
|
||||
|
||||
# -- Options for LaTeX output -------------------------------------------------
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title, author, documentclass
|
||||
# [howto/manual]).
|
||||
latex_documents = [
|
||||
('index',
|
||||
'%s.tex' % project,
|
||||
'doc-%s.tex' % project,
|
||||
'%s Documentation' % project,
|
||||
'OpenStack Foundation', 'manual'),
|
||||
]
|
||||
|
||||
# Example configuration for intersphinx: refer to the Python standard library.
|
||||
#intersphinx_mapping = {'http://docs.python.org/': None}
|
||||
# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
|
||||
latex_use_xindy = False
|
||||
|
||||
# sphinxcontrib.apidoc options
|
||||
config_generator_config_file = (
|
||||
'../../etc/masakarimonitors/masakarimonitors-config-generator.conf')
|
||||
sample_config_basename = '_static/masakarimonitors'
|
||||
# Disable smartquotes, they don't work in latex
|
||||
smartquotes_excludes = {'builders': ['latex']}
|
||||
|
@@ -17,20 +17,21 @@ Contents:
|
||||
reference/conf
|
||||
reference/conf-file
|
||||
|
||||
For Contributors
|
||||
================
|
||||
.. only:: html
|
||||
|
||||
* If you are a new contributor to Masakari Monitors please refer: :doc:`contributor/contributing`
|
||||
For Contributors
|
||||
================
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
* If you are a new contributor to Masakari Monitors please refer: :doc:`contributor/contributing`
|
||||
|
||||
contributor/contributing
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
contributor/contributing
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
8
tox.ini
8
tox.ini
@@ -43,6 +43,14 @@ deps =
|
||||
-r{toxinidir}/doc/requirements.txt
|
||||
commands = sphinx-build -W -b html doc/source doc/build/html
|
||||
|
||||
[testenv:pdf-docs]
|
||||
deps = {[testenv:docs]deps}
|
||||
whitelist_externals =
|
||||
make
|
||||
commands =
|
||||
sphinx-build -W -b latex doc/source doc/build/pdf
|
||||
make -C doc/build/pdf
|
||||
|
||||
[testenv:releasenotes]
|
||||
deps = {[testenv:docs]deps}
|
||||
commands =
|
||||
|
Reference in New Issue
Block a user