Files

79 lines
2.6 KiB
INI
Raw Permalink Normal View History

[tox]
minversion = 4.0
envlist = publishdocs
skipsdist = True
ignore_basepython_conflict = True
[testenv]
basepython = python3
setenv =
VIRTUAL_ENV={envdir}
deps =
-r{toxinidir}/test-requirements.txt
allowlist_externals =
mkdir
rm
rsync
bash
[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:generatepot-training]
# Generate POT files for translation
commands =
rm -f doc/upstream-training/source/locale/upstream-training.pot
sphinx-build -b gettext doc/upstream-training/source/slides \
doc/upstream-training/source/locale/
sphinx-build -b gettext doc/upstream-training/source/website \
doc/upstream-training/source/locale/
2023年09月18日 17:09:56 +09:00
bash -c "msgcat --use-first --sort-by-file doc/upstream-training/source/locale/*.pot \
> doc/upstream-training/source/upstream-training.pot && \
rm doc/upstream-training/source/locale/*.pot && \
rm -rf doc/upstream-training/source/locale/.doctrees/ && \
mv doc/upstream-training/source/upstream-training.pot doc/upstream-training/source/locale/upstream-training.pot"
[testenv:publishdocs]
allowlist_externals =
mkdir
rm
rsync
bash
{toxinidir}/tools/add-marker.sh
{toxinidir}/tools/buildlang.sh
# These are needed for writing the root-marker
passenv =
ZUUL*
commands =
Reorganize directory structure Currently for both upstream-training and training-guide directory slides are stored in the subdirectories of landing web pages. It is not easy to capture the directory structure and this requires Sphinx conf file to have unnecessary excluded entries. This commits reorganizes each directory to the following structure. It follows the convention in the documentation project. doc/upstream-training: (previous) +-- README.rst +-- website RST files +-- conf.py (for website) +-- build/ +-- source/ +-- slide RST files +-- conf.py (for slides) +-- _assets/ +-- _static/ +-- locale/ (new) +-- README.rst +-- build/ +-- source/ +-- website/ | +-- website RST files | +-- conf.py (for website) | +-- _assets/ +-- slides/ | +-- slide RST files | +-- conf.py (for slides) | +-- _assets/ | +-- _static/ +-- locales/ training-guide directory is reorganized similarly. training-guide _assets/README has been removed as it is used. Also updates tox.ini to share target command definitions. We do not need to have same things in many places. Note that this commit does not change the build document paths. Change-Id: I5a21f170c06d8f71f1f2d0df354e6d6280cb29d0
2016年10月07日 06:00:11 +09:00
{[testenv:upstream-slides]commands}
# Publish
mkdir -p publish-docs/html/upstream-training
rsync -av doc/upstream-training/build/slides/ publish-docs/html/upstream-training/
{toxinidir}/tools/add-marker.sh publish-docs/html/upstream-training
# Publish translated guides
{toxinidir}/tools/buildlang.sh
[testenv:upstream-slides]
commands =
# Niceness test
doc8 doc/upstream-training
# Build upstream-training slides
Reorganize directory structure Currently for both upstream-training and training-guide directory slides are stored in the subdirectories of landing web pages. It is not easy to capture the directory structure and this requires Sphinx conf file to have unnecessary excluded entries. This commits reorganizes each directory to the following structure. It follows the convention in the documentation project. doc/upstream-training: (previous) +-- README.rst +-- website RST files +-- conf.py (for website) +-- build/ +-- source/ +-- slide RST files +-- conf.py (for slides) +-- _assets/ +-- _static/ +-- locale/ (new) +-- README.rst +-- build/ +-- source/ +-- website/ | +-- website RST files | +-- conf.py (for website) | +-- _assets/ +-- slides/ | +-- slide RST files | +-- conf.py (for slides) | +-- _assets/ | +-- _static/ +-- locales/ training-guide directory is reorganized similarly. training-guide _assets/README has been removed as it is used. Also updates tox.ini to share target command definitions. We do not need to have same things in many places. Note that this commit does not change the build document paths. Change-Id: I5a21f170c06d8f71f1f2d0df354e6d6280cb29d0
2016年10月07日 06:00:11 +09:00
sphinx-build -W -b slides -d doc/upstream-training/build/slides.doctrees doc/upstream-training/source/slides doc/upstream-training/build/slides
# Build upstream landing page index.html
Reorganize directory structure Currently for both upstream-training and training-guide directory slides are stored in the subdirectories of landing web pages. It is not easy to capture the directory structure and this requires Sphinx conf file to have unnecessary excluded entries. This commits reorganizes each directory to the following structure. It follows the convention in the documentation project. doc/upstream-training: (previous) +-- README.rst +-- website RST files +-- conf.py (for website) +-- build/ +-- source/ +-- slide RST files +-- conf.py (for slides) +-- _assets/ +-- _static/ +-- locale/ (new) +-- README.rst +-- build/ +-- source/ +-- website/ | +-- website RST files | +-- conf.py (for website) | +-- _assets/ +-- slides/ | +-- slide RST files | +-- conf.py (for slides) | +-- _assets/ | +-- _static/ +-- locales/ training-guide directory is reorganized similarly. training-guide _assets/README has been removed as it is used. Also updates tox.ini to share target command definitions. We do not need to have same things in many places. Note that this commit does not change the build document paths. Change-Id: I5a21f170c06d8f71f1f2d0df354e6d6280cb29d0
2016年10月07日 06:00:11 +09:00
sphinx-build -W -b html -d doc/upstream-training/build/slides.doctrees doc/upstream-training/source/website doc/upstream-training/build/slides
[testenv:training-slides]
commands =
# Niceness test
doc8 doc/training-guides
# Build training-guides slides
Reorganize directory structure Currently for both upstream-training and training-guide directory slides are stored in the subdirectories of landing web pages. It is not easy to capture the directory structure and this requires Sphinx conf file to have unnecessary excluded entries. This commits reorganizes each directory to the following structure. It follows the convention in the documentation project. doc/upstream-training: (previous) +-- README.rst +-- website RST files +-- conf.py (for website) +-- build/ +-- source/ +-- slide RST files +-- conf.py (for slides) +-- _assets/ +-- _static/ +-- locale/ (new) +-- README.rst +-- build/ +-- source/ +-- website/ | +-- website RST files | +-- conf.py (for website) | +-- _assets/ +-- slides/ | +-- slide RST files | +-- conf.py (for slides) | +-- _assets/ | +-- _static/ +-- locales/ training-guide directory is reorganized similarly. training-guide _assets/README has been removed as it is used. Also updates tox.ini to share target command definitions. We do not need to have same things in many places. Note that this commit does not change the build document paths. Change-Id: I5a21f170c06d8f71f1f2d0df354e6d6280cb29d0
2016年10月07日 06:00:11 +09:00
sphinx-build -W -b slides -d doc/training-guides/build/slides.doctrees/associate-guide doc/training-guides/source/slides doc/training-guides/build/slides/associate-guide
# Build training-guides landing page index.html
Reorganize directory structure Currently for both upstream-training and training-guide directory slides are stored in the subdirectories of landing web pages. It is not easy to capture the directory structure and this requires Sphinx conf file to have unnecessary excluded entries. This commits reorganizes each directory to the following structure. It follows the convention in the documentation project. doc/upstream-training: (previous) +-- README.rst +-- website RST files +-- conf.py (for website) +-- build/ +-- source/ +-- slide RST files +-- conf.py (for slides) +-- _assets/ +-- _static/ +-- locale/ (new) +-- README.rst +-- build/ +-- source/ +-- website/ | +-- website RST files | +-- conf.py (for website) | +-- _assets/ +-- slides/ | +-- slide RST files | +-- conf.py (for slides) | +-- _assets/ | +-- _static/ +-- locales/ training-guide directory is reorganized similarly. training-guide _assets/README has been removed as it is used. Also updates tox.ini to share target command definitions. We do not need to have same things in many places. Note that this commit does not change the build document paths. Change-Id: I5a21f170c06d8f71f1f2d0df354e6d6280cb29d0
2016年10月07日 06:00:11 +09:00
sphinx-build -b html -d doc/training-guides/build/slides.doctrees doc/training-guides/source/website doc/training-guides/build/slides