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
Use toctree in slide-index.rst to ensure all documents are listed
in toctree to avoid sphinx warnings.
Exclude associate-guides from HTML build. Also remove 'source' from
doc/training-guides/conf.py as it does not exists in doc/training-guide.
Ensure associate-guide/notes files are in toctree to avoid sphinx warnings.
These files are referred to by including them, so hidden toctrees are used.
Also specifies sphinx-build -W option to detect warnings.
Change-Id: I298202e3304d02f362cc4bf9cc58686857040fd8
Most warnings are "document isn't included in any toctree".
This is because documents are not listed in any toctree.
In the upstream training document, explicit toctree looks unnecessary,
so this commit adds a hidden toctree to cover all unlisted documents.
It makes these documents reachable from standard navigation (prev/next).
doc/upstream-training/README.rst is not intended to link from the document.
Add README.rst to exclude_patterns in conf.py.
Also specifies sphinx-build -W option to detect warnings.
Change-Id: I42750cde20a35342dce7857e275f7fa27211236b
Add marker correctly, we cannot redirect in tox.ini, thus need a shell
script to do the redirects.
This adds a new shell script to just add a marker call add-marker.sh
Change-Id: I76cd140ad5ac1fb2163a11ab760134256b04f8dd
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
For new infra publishing setup, each guide needs have a .root-marker
file in its top-level directory. Add the marker for each guide.
Change-Id: I46026a90d148b28c4e4b80177c912b0954413aef
Doctrees are build artefacts thta do not need to be published, place
them in separete directories so that they won't get published.
Change-Id: I8839f08d2e85ccb751d354be5f48bdfd95b886e2
generatelabs file was used to created for training-labs
scripts, and is not used in this repository anymore.
Also, updated tox.ini to delete generatelabs references
Change-Id: I86894506c62e2466734194f62a28811e5c2c8c4e
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
* since training-guides repo is not so frequently updated,
publish the translated guides with the original guide.
* also, remove the unnecessary tox environment.
Change-Id: I8b413d7e8343e661e3d1bdeb5db8b58fa07c0e29
Upstream training is currently published as draft. Enable publishing as a
regular content on docs.openstack.org/upstream-training.
Change-Id: I9efa7918d84acd7d637f063b3ef8b07291072c15
Adds a new openstackdocs themed landing page for Upstream training. Renames
old landing page to slide-index.html (so users that prefer slide-only landing
page can still use it).
Change-Id: I8575af8e5b70940e5252c86e8c584261e0e29ab4
Closes-Bug: #1494724
Start publishing training gudies to draft. This also
enables preview during the review on the gerrit interface.
Change-Id: Ibd7090f6ce130fbec73586acece223f81b120122
Create publishbuild and checkbuild targets so that the upstream-training
slides will be gated and published at
http://docs.openstack.org/draft/upstream-training
Change-Id: I2ad3736cbd5e66d07bb84ffb9f805a0270663f7b
- delete landslide files
- convert existing rst files to Hieroglyph format
- add new slide build command to the tox.ini
- change default CSS to make output more OpenStack-like
- used the Foundation Slides' OpenStack-Powered-April2015.ppt
- title slide with image
- white h1 css text
- "openstack's special red" for h2
Change-Id: Icb22482862a85c3d174d9292fb470f64fb95f7aa
Updates bashate checks to cover the labs folder more throughly and
also omit all other possible files.
Change-Id: I9ad1ef55b54351e21175db8bb08bc44526e952e9
Update the current gate 'slides' to build and publish upstream
training content. This patch does the following changes.
* Adds generateslides script to use sphinx/hieroglyph to build slides
* Updates tox.ini to use generateslides script
* Update .gitignore to ignore _build/ directory which is the default
folder for generated output generated by sphix.
Hence forth, any changes to the upstream training rst slides will be
gated and published, also it is essential to note that these jobs are
new and may not be accurate or reliable to address all the errors in
the rst slides.
Change-Id: I8a220dd31501f9b3733a6282d7048fe283d2a0d1
- rename tox option for building upstream slides only (useful when "debugging"
slide content and appearance), adds doc8 syntax checking
- update ignore-path for doc8 (include also the (future) build directory for
the training guides)
Change-Id: I112f4f20f676e369f7369ed036b14464862ea3ef
modifided tox.ini and requirements.txt to install
hieroglyph, added some changes in the styles
of the individual .rst files to support hiero
Change-Id: Id2674e593857470cf4efa0706a4fbda33813f374
Address the change from XML to RST, XML based jobs are disabled. Current
content in Juno release for training guides is not going to include any
XML Docbook content. This patch disables the XML related jobs.
This patch will be followed by more jobs added to build RST content to
HTML and PDF format as required using the tools decided by the team. The
jobs disabled will be re-enabled with the appropriate set of tools.
Deletes all the jobs which are not required. Addresses changes done by
https://review.openstack.org/#/c/152118.
Change-Id: I91727929fe19dbc7487f2719cdba80157c543d6b
Add slides tox environment for building RST based slides. This tox
environment needs to be enhanced moving forward. For now it includes
the doc8 test to test RST and txt files. Also setup doc8 testing.
Change-Id: I76e0d235b9ee89c8de8033a7119e34cbcf1f0ddd
This changeset reverts "labs: temporary wbatch fix" and replaces it with
a proper fix, allowing the creation of correct Windows batch files on
build hosts without VirtualBox.
Change-Id: Iad005ce9f0dcecb910fc09b2c43385dd42992eda
The Windows batch files created on the build host have a defect. This
patch should produce zip files with correct scripts until we have a
proper fix.
Change-Id: I9563bd6374d8e020dea29f300fab9c618f3e1987
Our documentation tools are not python3 compatible, so make sure that
tox creates python2 virtual environments during tests.
Change-Id: I86f160fb952ebce8abbac166fe43aae0e7d57005
Generate Windows batch files using osbash.sh and create a zip archive
of the labs directory (for Windows users).
Change-Id: I98005cb390f80ec1681914be041084dfa737ffa5
Makes required directories since they are not created by the doc tools
if only *.po/*.pot files in locale directories are touched.
Change-Id: Iaa206a414f29972f4b627a2cc3a29b52ff85cc25
Generates tar files for labs section for those who want to run the
lab scripts without having to install git and cloning the entire
repository.
Change-Id: I48056f3195b43dec0e15152ee1777b936e29a24d
Setup the same way the other repos are setup.
Note that currently no jobs are run since training-guides has no
localization. But let's keep the setup in sync.
Change-Id: I7e9ced06c3ad9997d7f790a5a4d507fa13ef0490
This is a new non-voting job that will be used for changes of the
manual. It checks that URLs in the manual are reachable and valid.
Change-Id: Iaa9c3f0285aee900f3f51a10669904d72e1113b7
Note that this does not build any translated guides yet since we do not
have the guides translated properly into any language.
This infrastructure is needed to enable the translations.
Change-Id: I2accb7e713ed88a3e06edca31bb7691d2d0bc14c
