From 75b8afcffedc76c7b22fd2289e5b25d65cc074c2 Mon Sep 17 00:00:00 2001 From: Vladimir Kozhukalov Date: Thu, 27 Apr 2023 11:18:02 +0300 Subject: [PATCH] Add pdf-docs tox env Story: 2006104 Task: 35274 Change-Id: I949a5b26f3b46f8a5fc4514c268ddc45a502d744 --- doc/source/conf.py | 5 +++-- tox.ini | 11 +++++++++++ 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index fc9c8ebd..0145c7d2 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -37,13 +37,14 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = 'OpenStack Helm Images' +project = 'openstack-helm-images' copyright = '2018, OpenStack Developers' # openstackdocstheme options openstackdocs_repo_name = 'openstack/openstack-helm-images' openstackdocs_auto_name = False openstackdocs_use_storyboard = True +openstackdocs_pdf_link = True # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -72,7 +73,7 @@ htmlhelp_basename = '%sdoc' % project # [howto/manual]). latex_documents = [ ('index', - '%s.tex' % project, + 'doc-%s.tex' % project, '%s Documentation' % project, 'OpenStack Developers', 'manual'), ] diff --git a/tox.ini b/tox.ini index c6c5d17a..3ae53faa 100644 --- a/tox.ini +++ b/tox.ini @@ -29,6 +29,17 @@ commands = doc8 doc sphinx-build -W --keep-going -b html doc/source doc/build/html +[testenv:pdf-docs] +envdir = {toxworkdir}/docs +deps = {[testenv:docs]deps} +allowlist_externals = + make + rm +commands = + rm -rf doc/build/pdf + sphinx-build -W --keep-going -b latex -j auto doc/source doc/build/pdf + make -C doc/build/pdf + [doc8] extensions = .rst