Add tox -e api-ref CLI

Closes-Bug: #1989110

Change-Id: I2063f51a38daf74c1e493b334e78045b3dd99d7b
This commit is contained in:
zhangbailin 2022-09-08 17:26:21 +08:00
parent 96f6401b28
commit 0fb1d453de
2 changed files with 14 additions and 1 deletions

View File

@ -58,6 +58,7 @@ html_theme_options = {
# (source start file, target name, title, author, documentclass # (source start file, target name, title, author, documentclass
# [howto/manual]). # [howto/manual]).
latex_documents = [ latex_documents = [
('index', 'Venus.tex', u'OpenStack Log API Documentation', ('index', 'Venus.tex',
u'OpenStack Log Management Service API Documentation',
u'OpenStack Foundation', 'manual'), u'OpenStack Foundation', 'manual'),
] ]

12
tox.ini
View File

@ -66,6 +66,18 @@ commands =
rm -rf doc/build/html rm -rf doc/build/html
sphinx-build -W -b html doc/source doc/build/html sphinx-build -W -b html doc/source doc/build/html
[testenv:api-ref]
description =
Generate the API ref. Called from CI scripts to test and publish to docs.openstack.org.
# This environment is called from CI scripts to test and publish
# the API Ref to docs.openstack.org.
envdir = {toxworkdir}/docs
deps = {[testenv:docs]deps}
commands =
rm -rf api-ref/build
sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
allowlist_externals = rm
[flake8] [flake8]
# Following checks are ignored on purpose. # Following checks are ignored on purpose.
# #