PDF documentation build
- add the pdf-docs tox environment according the established guidelines; - remove a useless extra title (for both builders); - docs tox environment: clean up only the generated html, not the entire build directory; - disable the too smart smartquotes option for the latex builder; - improve the title of the latex document. Story: 2006117 Task: 35492 Change-Id: I353e33db27c8d676398973995960b98d3163aa0d
This commit is contained in:
parent
ec284ea9a2
commit
47ee6040fa
|
@ -112,10 +112,6 @@ html_theme = 'openstackdocs'
|
||||||
# using the given strftime format.
|
# using the given strftime format.
|
||||||
#html_last_updated_fmt = '%b %d, %Y'
|
#html_last_updated_fmt = '%b %d, %Y'
|
||||||
|
|
||||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
|
||||||
# typographically correct entities.
|
|
||||||
html_use_smartypants = False
|
|
||||||
|
|
||||||
# Custom sidebar templates, maps document names to template names.
|
# Custom sidebar templates, maps document names to template names.
|
||||||
#html_sidebars = {}
|
#html_sidebars = {}
|
||||||
|
|
||||||
|
@ -159,7 +155,7 @@ htmlhelp_basename = 'saharamaprplugin-testsdoc'
|
||||||
# Grouping the document tree into LaTeX files. List of tuples
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
# (source start file, target name, title, author, documentclass [howto/manual]).
|
# (source start file, target name, title, author, documentclass [howto/manual]).
|
||||||
latex_documents = [
|
latex_documents = [
|
||||||
('index', 'sahara-plugin-mapr.tex', u'sahara-plugin-mapr Documentation',
|
('index', 'doc-sahara-plugin-mapr.tex', u'Sahara MapR Plugin Documentation',
|
||||||
u'Sahara team', 'manual'),
|
u'Sahara team', 'manual'),
|
||||||
]
|
]
|
||||||
|
|
||||||
|
@ -183,6 +179,7 @@ latex_documents = [
|
||||||
# If false, no module index is generated.
|
# If false, no module index is generated.
|
||||||
#latex_domain_indices = True
|
#latex_domain_indices = True
|
||||||
|
|
||||||
|
smartquotes_excludes = {'builders': ['latex']}
|
||||||
|
|
||||||
# -- Options for manual page output --------------------------------------------
|
# -- Options for manual page output --------------------------------------------
|
||||||
|
|
||||||
|
|
|
@ -1,8 +1,5 @@
|
||||||
MapR plugin for Sahara
|
MapR plugin for Sahara
|
||||||
=======================
|
======================
|
||||||
|
|
||||||
User Guide
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
13
tox.ini
13
tox.ini
|
@ -51,11 +51,22 @@ deps =
|
||||||
-c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt}
|
-c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt}
|
||||||
-r{toxinidir}/doc/requirements.txt
|
-r{toxinidir}/doc/requirements.txt
|
||||||
commands =
|
commands =
|
||||||
rm -rf doc/html doc/build
|
rm -rf doc/build/html
|
||||||
sphinx-build -W -b html doc/source doc/build/html
|
sphinx-build -W -b html doc/source doc/build/html
|
||||||
whitelist_externals =
|
whitelist_externals =
|
||||||
rm
|
rm
|
||||||
|
|
||||||
|
[testenv:pdf-docs]
|
||||||
|
basepython = python3
|
||||||
|
deps = {[testenv:docs]deps}
|
||||||
|
commands =
|
||||||
|
rm -rf doc/build/pdf
|
||||||
|
sphinx-build -W -b latex doc/source doc/build/pdf
|
||||||
|
make -C doc/build/pdf
|
||||||
|
whitelist_externals =
|
||||||
|
make
|
||||||
|
rm
|
||||||
|
|
||||||
[testenv:releasenotes]
|
[testenv:releasenotes]
|
||||||
basepython = python3
|
basepython = python3
|
||||||
deps =
|
deps =
|
||||||
|
|
Loading…
Reference in New Issue