diff --git a/doc/source/conf.py b/doc/source/conf.py index 999c957..82cec60 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -112,10 +112,6 @@ html_theme = 'openstackdocs' # using the given strftime format. #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. #html_sidebars = {} @@ -159,7 +155,7 @@ htmlhelp_basename = 'saharamaprplugin-testsdoc' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). 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'), ] @@ -183,6 +179,7 @@ latex_documents = [ # If false, no module index is generated. #latex_domain_indices = True +smartquotes_excludes = {'builders': ['latex']} # -- Options for manual page output -------------------------------------------- diff --git a/doc/source/index.rst b/doc/source/index.rst index 41e19aa..8999811 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,8 +1,5 @@ MapR plugin for Sahara -======================= - -User Guide ----------- +====================== .. toctree:: :maxdepth: 2 diff --git a/tox.ini b/tox.ini index b768384..5da3bf8 100644 --- a/tox.ini +++ b/tox.ini @@ -51,11 +51,22 @@ deps = -c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt} -r{toxinidir}/doc/requirements.txt commands = - rm -rf doc/html doc/build + rm -rf doc/build/html sphinx-build -W -b html doc/source doc/build/html whitelist_externals = 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] basepython = python3 deps =