openstack
/
monasca-log-api
Code Issues Proposed changes

tox: Stop building *all* docs in 'docs' 

The 'docs' target currently builds the documentation trees in 'api-ref'
and 'api-guide', in addition to 'doc'. This massively increases the
amount of time docs take to build both locally and in the gate. It's
not necessary for gate, since separate jobs take care of the other
documents for barbican.  As such, we should stop doing it.

For users that *do* care about this (for whatever reason) a new
'all-docs' target is included.

Change-Id: I3aa314f8643fcb4da93f8642034edddc2145bc32
This commit is contained in:
Andreas Jaeger 2018-10-27 16:48:26 +02:00
parent f735e546b5
commit 2eaf6b3aff
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
tox.ini
View File

@ -82,12 +82,9 @@ commands = oslopolicy-sample-generator --config-file=config-generator/policy.con
[testenv:docs]
basepython = python3
description = Builds api-ref, api-guide, releasenotes and devdocs
description = Builds main documention
commands =
{[testenv:devdocs]commands}
{[testenv:api-guide]commands}
{[testenv:api-ref]commands}
{[testenv:releasenotes]commands}
[testenv:api-guide]
basepython = python3
@ -112,6 +109,15 @@ commands =
rm -rf releasenotes/build
sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
[testenv:all-docs]
basepython = python3
description = Builds all docouments
commands =
{[testenv:devdocs]commands}
{[testenv:api-guide]commands}
{[testenv:api-ref]commands}
{[testenv:releasenotes]commands}
[testenv:devdocs]
basepython = python3
description = Builds developer documentation