Merge "Add pdf-docs tox env"

This commit is contained in:
Zuul 2023-05-08 22:53:09 +00:00 committed by Gerrit Code Review
commit 35cd178eab
2 changed files with 14 additions and 2 deletions

View File

@ -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'),
]

11
tox.ini
View File

@ -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