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
This commit is contained in:
Akihiro Motoki
2016年10月07日 06:00:11 +09:00
parent 44ba0d5a95
commit 383a5bec4b

31
tox.ini
View File

@@ -25,17 +25,8 @@ 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 -W -b html -d doc/upstream-training/build/slides.doctrees doc/upstream-training doc/upstream-training/build/slides
# Build training-guides slides
sphinx-build -W -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
{[testenv:upstream-slides]commands}
{[testenv:training-slides]commands}
# Publish for check site
mkdir -p publish-docs/upstream-training
mkdir -p publish-docs/training-guides
@@ -45,14 +36,8 @@ commands =
[testenv:publishdocs]
passenv = ZUUL*
commands =
# 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 -W -b html -d doc/upstream-training/build/slides.doctrees/ doc/upstream-training doc/upstream-training/build/slides
# Build training-guides slides
sphinx-build -W -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 -W -b html -d doc/training-guides/build/slides.doctrees doc/training-guides doc/training-guides/build/slides doc/training-guides/index.rst
{[testenv:upstream-slides]commands}
{[testenv:training-slides]commands}
# Publish as draft
mkdir -p publish-docs/draft/training-guides
rsync -av doc/training-guides/build/slides/ publish-docs/draft/training-guides/
@@ -69,18 +54,18 @@ commands =
# Niceness test
doc8 doc/upstream-training
# Build upstream-training slides
sphinx-build -W -b slides doc/upstream-training/source/ doc/upstream-training/build/slides
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
sphinx-build -W -b html doc/upstream-training doc/upstream-training/build/slides
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
sphinx-build -W -b slides doc/training-guides/associate-guide/ doc/training-guides/build/slides/associate-guide
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
sphinx-build -W -b html doc/training-guides doc/training-guides/build/slides doc/training-guides/index.rst
sphinx-build -b html -d doc/training-guides/build/slides.doctrees doc/training-guides/source/website doc/training-guides/build/slides
[testenv:generatepot-training]
# Generate POT files for translation
Reference in New Issue
openstack/training-guides
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.

The note is not visible to the blocked user.