starlingx/docs
Code Issues Proposed changes

Merge "Add tabbed output support (r8)"

Browse Source
This commit is contained in:
Zuul 2023-09-21 14:51:45 +00:00 committed by Gerrit Code Review
commit e33bf94a76
3 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/requirements.txt
View File

@ -2,6 +2,7 @@ sphinx==4.2.0
openstackdocstheme>=2.2.1,<=2.3.1 # Apache-2.0 openstackdocstheme>=2.2.1,<=2.3.1 # Apache-2.0
docutils==0.17.1 docutils==0.17.1
PyYAML==6.0 PyYAML==6.0
sphinx-tabs<=3.4.1
# API Reference Guide # API Reference Guide
os-api-ref>=1.5.0 # Apache-2.0 os-api-ref>=1.5.0 # Apache-2.0

3
doc/source/conf.py
View File

@ -36,7 +36,8 @@ author = 'StarlingX'
# ones. # ones.
extensions = [ extensions = [
# 'openstackdocstheme', # 'openstackdocstheme',
'starlingxdocs_plus' 'starlingxdocs_plus',
'sphinx_tabs.tabs'
] ]
if tags.has('use_spellext'): if tags.has('use_spellext'):

2
tox.ini
View File

@ -35,7 +35,7 @@ deps =
-r{toxinidir}/doc/requirements.txt -r{toxinidir}/doc/requirements.txt
commands = commands =
{[testenv:prebuild-docs]commands} {[testenv:prebuild-docs]commands}
sphinx-build -a -E -W --keep-going -d doc/build/doctrees -t starlingx -t openstack -b html doc/source doc/build/html {posargs} sphinx-build -a -E -W --keep-going -d doc/build/doctrees -t starlingx -t openstack -t virtual -b html doc/source doc/build/html {posargs}
{[testenv:postbuild-docs]commands} {[testenv:postbuild-docs]commands}
# Note: The dev env for the docs team uses a version of tox that does not yet support allowlist_externals # Note: The dev env for the docs team uses a version of tox that does not yet support allowlist_externals
whitelist_externals = bash whitelist_externals = bash