9fab9582c2
Most warnings can be addressed by using toctree directive and there is no reason to use toctree directive. In addition, sections in slide-index.rst has been reorganized to match the sections in index.rst. The sections in index.rst looks better. Also specify -W option to sphinx-build so that the gate job can detect warnings. Change-Id: I70ca7c2b61cbbb48fd0ea5e6cc0d68aaa09b6d87
88 lines
3.7 KiB
INI
88 lines
3.7 KiB
INI
[tox]
|
|
minversion = 1.6
|
|
envlist = checkbuild
|
|
skipsdist = True
|
|
|
|
[testenv]
|
|
basepython = python2
|
|
setenv = VIRTUAL_ENV={envdir}
|
|
install_command = pip install -U {opts} {packages}
|
|
deps = -r{toxinidir}/test-requirements.txt
|
|
whitelist_externals =
|
|
mkdir
|
|
rm
|
|
rsync
|
|
|
|
[testenv:venv]
|
|
commands = {posargs}
|
|
|
|
[doc8]
|
|
# Settings for doc8:
|
|
# File extensions to use
|
|
extension = .rst,.txt
|
|
ignore-path = doc/upstream-training/build/*,doc/training-guides/build/*
|
|
|
|
[testenv:checkbuild]
|
|
commands =
|
|
# Niceness test
|
|
doc8 doc/upstream-training
|
|
doc8 doc/training-guides
|
|
# Build upstream-training slides
|
|
sphinx-build -W -b slides -d doc/upstream-training/build/slides.doctrees doc/upstream-training/source/ doc/upstream-training/build/slides
|
|
# Build upstream landing page
|
|
sphinx-build -b html -d doc/upstream-training/build/slides.doctrees doc/upstream-training doc/upstream-training/build/slides
|
|
# Build training-guides slides
|
|
sphinx-build -b slides -d doc/training-guides/build/slides.doctrees/associate-guide doc/training-guides/associate-guide/ doc/training-guides/build/slides/associate-guide
|
|
# Build training-guides landing page
|
|
sphinx-build -b html -d doc/training-guides/build/slides.doctrees doc/training-guides doc/training-guides/build/slides doc/training-guides/index.rst
|
|
# Publish for check site
|
|
mkdir -p publish-docs/upstream-training
|
|
mkdir -p publish-docs/training-guides
|
|
rsync -av doc/upstream-training/build/slides/ publish-docs/upstream-training/
|
|
rsync -av doc/training-guides/build/slides/ publish-docs/training-guides/
|
|
|
|
[testenv:publishdocs]
|
|
commands =
|
|
# Build upstream-training slides
|
|
sphinx-build -b slides -d doc/upstream-training/build/slides.doctrees/ doc/upstream-training/source/ doc/upstream-training/build/slides
|
|
# Build upstream landing page
|
|
sphinx-build -b html -d doc/upstream-training/build/slides.doctrees/ doc/upstream-training doc/upstream-training/build/slides
|
|
# Build training-guides slides
|
|
sphinx-build -b slides -d doc/training-guides/build/slides.doctrees/associate-guide doc/training-guides/associate-guide/ doc/training-guides/build/slides/associate-guide
|
|
# Build training-guides landing page
|
|
sphinx-build -b html -d doc/training-guides/build/slides.doctrees doc/training-guides doc/training-guides/build/slides doc/training-guides/index.rst
|
|
# This marker is needed for infra publishing
|
|
MARKER_TEXT="Project: $ZUUL_PROJECT Ref: $ZUUL_REFNAME Build: $ZUUL_UUID"
|
|
# Publish as draft
|
|
mkdir -p publish-docs/draft/training-guides
|
|
rsync -av doc/training-guides/build/slides/ publish-docs/draft/training-guides/
|
|
echo $MARKER_TEXT > publish-docs/draft/training-guides/.root-marker
|
|
# Publish
|
|
mkdir -p publish-docs/upstream-training
|
|
rsync -av doc/upstream-training/build/slides/ publish-docs/upstream-training/
|
|
echo $MARKER_TEXT > publish-docs/upstream-training/.root-marker
|
|
# Publish translated guides
|
|
{toxinidir}/tools/buildlang.sh
|
|
|
|
[testenv:upstream-slides]
|
|
commands =
|
|
# Niceness test
|
|
doc8 doc/upstream-training
|
|
# Build upstream-training slides
|
|
sphinx-build -b slides doc/upstream-training/source/ doc/upstream-training/build/slides
|
|
# Build upstream landing page index.html
|
|
sphinx-build -b html doc/upstream-training doc/upstream-training/build/slides
|
|
|
|
[testenv:training-slides]
|
|
commands =
|
|
# Niceness test
|
|
doc8 doc/training-guides
|
|
# Build training-guides slides
|
|
sphinx-build -b slides doc/training-guides/associate-guide/ doc/training-guides/build/slides/associate-guide
|
|
# Build training-guides landing page index.html
|
|
sphinx-build -b html doc/training-guides doc/training-guides/build/slides doc/training-guides/index.rst
|
|
|
|
[testenv:generatepot-training]
|
|
# Generate POT files for translation
|
|
commands = {toxinidir}/tools/generatepot-training.sh
|