From c96edc79759494d4d78c379216133fbf8d34d31e Mon Sep 17 00:00:00 2001 From: sonpn13 Date: Sun, 27 Oct 2019 09:31:44 +0700 Subject: [PATCH] PDF Documentation Build tox target Change-Id: I6f24c663ae188f36f7ac33ea57d175af501bbfd6 Signed-off-by: sonpn13 Story: 2006105 Task: 35339 --- doc/requirements.txt | 5 +++-- doc/source/_static/.gitkeep | 0 doc/source/conf.py | 13 ++++++++++++- tox.ini | 10 +++++++++- 4 files changed, 24 insertions(+), 4 deletions(-) create mode 100644 doc/source/_static/.gitkeep diff --git a/doc/requirements.txt b/doc/requirements.txt index 12390ff1..5ea362a9 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -10,7 +10,8 @@ # automatically be proposed to all the repositories which use it. 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 +sphinx>=1.8.0,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD +sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD +openstackdocstheme>=1.30.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0 doc8>=0.6.0 # Apache-2.0 diff --git a/doc/source/_static/.gitkeep b/doc/source/_static/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/doc/source/conf.py b/doc/source/conf.py index 96f0081b..0e8d8289 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -38,6 +38,7 @@ extensions = [ 'openstackdocstheme', 'sphinx.ext.autodoc', + 'sphinxcontrib.rsvgconverter', ] # Add any paths that contain templates here, relative to this directory. @@ -218,10 +219,12 @@ htmlhelp_basename = target_name + '-docs' # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, target_name + '.tex', + (master_doc, 'doc-' + target_name + '.tex', title, author, 'manual'), ] +latex_use_xindy = False + # The name of an image file (relative to this directory) to place at the top of # the title page. # latex_logo = None @@ -278,3 +281,11 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. # texinfo_no_detailmenu = False +# -- Options for PDF output -------------------------------------------------- + +pdf_documents = [ + (master_doc, target_name, + title, author) +] + +locale_dirs = ['locale/'] diff --git a/tox.ini b/tox.ini index 8febadd5..32b7ff1f 100644 --- a/tox.ini +++ b/tox.ini @@ -30,11 +30,19 @@ setenv = [testenv:docs] basepython = python3 deps = -r{toxinidir}/doc/requirements.txt -commands= +commands = bash -c "rm -rf doc/build" doc8 doc sphinx-build -b html doc/source doc/build/html +[testenv:pdf-docs] +basepython = python3 +deps = {[testenv:docs]deps} +whitelist_externals = + make +commands = + sphinx-build -W -b latex doc/source doc/build/pdf + make -C doc/build/pdf [doc8] # Settings for doc8: