763956c4b9
training-guides did not have any landing page, made difficult users to start reading the guide. This commit adds a landing page for training-guides. The previous landing page with slide format is moved from index.rst to slide-index.rst. Closes-Bug: #1535393 Change-Id: I8b43349679239e511173180777b27c3b18b518fb
99 lines
3.7 KiB
INI
99 lines
3.7 KiB
INI
[tox]
|
|
minversion = 1.6
|
|
envlist = slides
|
|
skipsdist = True
|
|
|
|
[testenv]
|
|
basepython = python2
|
|
setenv = VIRTUAL_ENV={envdir}
|
|
install_command = pip install -U {opts} {packages}
|
|
deps = -r{toxinidir}/test-requirements.txt
|
|
whitelist_externals =
|
|
bash
|
|
cp
|
|
mkdir
|
|
rm
|
|
rsync
|
|
sed
|
|
|
|
[testenv:venv]
|
|
commands = {posargs}
|
|
|
|
[testenv:slides]
|
|
# New RST based environment for building slides
|
|
# Note: Resulting files will not be made available anywhere.
|
|
commands =
|
|
# Niceness test for doc directory
|
|
doc8 doc
|
|
# Build labs tar/zip files
|
|
mkdir -p publish-docs/trunk/training-guides
|
|
# Build training labs scripts
|
|
bash {toxinidir}/tools/generatelabs
|
|
bash {toxinidir}/tools/generateslides
|
|
|
|
[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 -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 doc/upstream-training/index.rst doc/upstream-training/upstream-details.rst
|
|
# 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
|
|
# Publish as draft
|
|
mkdir -p publish-docs/draft/upstream-training
|
|
mkdir -p publish-docs/draft/training-guides
|
|
rsync -av doc/upstream-training/build/slides/ publish-docs/draft/upstream-training/
|
|
rsync -av doc/training-guides/build/slides/ publish-docs/draft/training-guides/
|
|
|
|
[testenv:publishdocs]
|
|
commands =
|
|
# 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 doc/upstream-training/index.rst doc/upstream-training/upstream-details.rst
|
|
# 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
|
|
# Publish as draft
|
|
mkdir -p publish-docs/draft/training-guides
|
|
rsync -av doc/training-guides/build/slides/ publish-docs/draft/training-guides/
|
|
# Publish
|
|
mkdir -p publish-docs/upstream-training
|
|
rsync -av doc/upstream-training/build/slides/ publish-docs/upstream-training/
|
|
# 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 doc/upstream-training/index.rst doc/upstream-training/upstream-details.rst
|
|
|
|
[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
|