openstack/openstack-helm
Code Issues Proposed changes

Merge "Add pdf-docs tox env"

Browse Source
This commit is contained in:
Zuul 2023-05-08 23:40:05 +00:00 committed by Gerrit Code Review
commit bfe9eca527
2 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/source/conf.py
View File

@ -28,6 +28,7 @@ extensions = [
openstackdocs_repo_name = 'openstack/openstack-helm' openstackdocs_repo_name = 'openstack/openstack-helm'
openstackdocs_auto_name = False openstackdocs_auto_name = False
openstackdocs_use_storyboard = True openstackdocs_use_storyboard = True
openstackdocs_pdf_link = True
# autodoc generation is a bit aggressive and a nuisance when doing heavy # autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles. # text edit cycles.
@ -86,7 +87,7 @@ htmlhelp_basename = '%sdoc' % project
# [howto/manual]). # [howto/manual]).
latex_documents = [ latex_documents = [
('index', ('index',
'%s.tex' % project, 'doc-%s.tex' % project,
'%s Documentation' % project, '%s Documentation' % project,
'OpenStack Foundation', 'manual'), 'OpenStack Foundation', 'manual'),
] ]

11
tox.ini
View File

@ -23,6 +23,17 @@ commands =
allowlist_externals = allowlist_externals =
rm rm
[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
[testenv:lint] [testenv:lint]
deps = deps =
yq yq