Merge "Porting presentations to Sphinx/Hieroglyph"
1
.gitignore
vendored
@ -7,6 +7,7 @@ target/
|
|||||||
publish-docs/
|
publish-docs/
|
||||||
generated/
|
generated/
|
||||||
/build-*.log.gz
|
/build-*.log.gz
|
||||||
|
build/
|
||||||
|
|
||||||
# Ignore Vagrant Related Files
|
# Ignore Vagrant Related Files
|
||||||
acceptance_config.yml
|
acceptance_config.yml
|
||||||
|
3
doc/upstream-training/LICENSE
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
This work is licensed under a Creative Commons Attribution 3.0 Unported License.
|
||||||
|
|
||||||
|
http://creativecommons.org/licenses/by/3.0/legalcode
|
@ -1,14 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
which landslide
|
|
||||||
LANDSLIDE_MISSING=$?
|
|
||||||
|
|
||||||
if [[ ${LANDSLIDE_MISSING} -ne 0 ]]; then
|
|
||||||
echo "landslide isn't on your path. Do you need to activate a virtual environment?"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
for presentation in *.rst; do
|
|
||||||
presentation_name=$(basename "${presentation}" .rst)
|
|
||||||
landslide -i -d "${presentation_name}.html" "${presentation}"
|
|
||||||
done
|
|
@ -1,9 +1,7 @@
|
|||||||
|
=======================
|
||||||
OpenStack Release Cycle
|
OpenStack Release Cycle
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
OpenStack Upstream Training
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
<teacher name>
|
<teacher name>
|
||||||
<date>
|
<date>
|
||||||
|
|
||||||
@ -12,28 +10,27 @@ OpenStack Upstream Training
|
|||||||
Planning : Design
|
Planning : Design
|
||||||
=================
|
=================
|
||||||
|
|
||||||
.. class:: colleft
|
.. rst-class:: colleft
|
||||||
|
|
||||||
- Planning stage is at the start of a cycle
|
- Planning stage is at the start of a cycle
|
||||||
- take a step back
|
- take a step back
|
||||||
- focus on what we want to do for the next one
|
- focus on what we want to do for the next one
|
||||||
|
|
||||||
.. class:: colright
|
|
||||||
.. image:: ./_assets/01-01-release.png
|
.. image:: ./_assets/01-01-release.png
|
||||||
|
|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
Planning : Discuss
|
Planning : Discuss
|
||||||
==================
|
==================
|
||||||
|
|
||||||
.. class:: colleft
|
.. rst-class:: colleft
|
||||||
|
|
||||||
- With our peers
|
- With our peers
|
||||||
- feedback and comments
|
- feedback and comments
|
||||||
- create the corresponding blueprint
|
- create the corresponding blueprint
|
||||||
- 4 weeks, Design Summit on the third week
|
- 4 weeks, Design Summit on the third week
|
||||||
|
|
||||||
.. class:: colright
|
|
||||||
.. image:: ./_assets/01-01-release.png
|
.. image:: ./_assets/01-01-release.png
|
||||||
|
|
||||||
----
|
----
|
||||||
@ -41,14 +38,15 @@ Planning : Discuss
|
|||||||
Planning : Target
|
Planning : Target
|
||||||
=================
|
=================
|
||||||
|
|
||||||
.. class:: colleft
|
.. rst-class:: colleft
|
||||||
|
|
||||||
- file new blueprints and/or specs
|
- file new blueprints and/or specs
|
||||||
- set a target milestone
|
- set a target milestone
|
||||||
- when in the cycle they intend to complete it
|
- when in the cycle they intend to complete it
|
||||||
- PTLs triage the submitted blueprints and set priority
|
- PTLs triage the submitted blueprints and set priority
|
||||||
|
|
||||||
.. class:: colright
|
.. rst-class:: colright
|
||||||
|
|
||||||
.. image:: ./_assets/01-01-release.png
|
.. image:: ./_assets/01-01-release.png
|
||||||
|
|
||||||
----
|
----
|
||||||
@ -56,14 +54,15 @@ Planning : Target
|
|||||||
Implementation : Milestone
|
Implementation : Milestone
|
||||||
==========================
|
==========================
|
||||||
|
|
||||||
.. class:: colleft
|
.. rst-class:: colleft
|
||||||
|
|
||||||
- pushed to our Gerrit review
|
- pushed to our Gerrit review
|
||||||
- weeks before the milestone publication date
|
- weeks before the milestone publication date
|
||||||
- milestone-proposed branch
|
- milestone-proposed branch
|
||||||
- feature-frozen
|
- feature-frozen
|
||||||
|
|
||||||
.. class:: colright
|
.. rst-class:: colright
|
||||||
|
|
||||||
.. image:: ./_assets/01-01-release.png
|
.. image:: ./_assets/01-01-release.png
|
||||||
|
|
||||||
----
|
----
|
||||||
@ -71,32 +70,32 @@ Implementation : Milestone
|
|||||||
Implementation : freezes
|
Implementation : freezes
|
||||||
========================
|
========================
|
||||||
|
|
||||||
.. class:: colleft
|
.. rst-class:: colleft
|
||||||
|
|
||||||
- Feature freeze
|
* Feature proposal freeze
|
||||||
|
|
||||||
- new features will not be accepted, only fixes
|
* not even proposals for features will be accepted
|
||||||
|
* focus on bug-fixing
|
||||||
|
|
||||||
- Feature proposal freeze
|
* Feature freeze
|
||||||
|
|
||||||
- not even proposals for features will be accepted
|
* new features will not be accepted, only fixes
|
||||||
- read: focus on bug-fixing
|
|
||||||
|
|
||||||
- String freeze
|
* String freeze
|
||||||
|
|
||||||
- all externally visible strings must be frozen
|
* all externally visible strings must be frozen
|
||||||
- this helps the translation and documentation program
|
* this helps the translation and documentation program
|
||||||
|
|
||||||
|
.. rst-class:: colright
|
||||||
|
|
||||||
.. class:: colright
|
|
||||||
.. image:: ./_assets/01-01-release.png
|
.. image:: ./_assets/01-01-release.png
|
||||||
|
|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
Release Candidates
|
Release Candidates
|
||||||
==================
|
==================
|
||||||
|
|
||||||
.. class:: colleft
|
.. rst-class:: colleft
|
||||||
|
|
||||||
- After the last milestone
|
- After the last milestone
|
||||||
- file bugs about everything you find
|
- file bugs about everything you find
|
||||||
@ -104,7 +103,8 @@ Release Candidates
|
|||||||
- write documentation
|
- write documentation
|
||||||
- fix as many bugs as you can
|
- fix as many bugs as you can
|
||||||
|
|
||||||
.. class:: colright
|
.. rst-class:: colright
|
||||||
|
|
||||||
.. image:: ./_assets/01-01-release.png
|
.. image:: ./_assets/01-01-release.png
|
||||||
|
|
||||||
----
|
----
|
||||||
@ -112,7 +112,7 @@ Release Candidates
|
|||||||
Release candidate 1
|
Release candidate 1
|
||||||
===================
|
===================
|
||||||
|
|
||||||
.. class:: colleft
|
.. rst-class:: colleft
|
||||||
|
|
||||||
- Between the last milestone and the RC1
|
- Between the last milestone and the RC1
|
||||||
- stop adding features and concentrate on bug fixes
|
- stop adding features and concentrate on bug fixes
|
||||||
@ -120,7 +120,9 @@ Release candidate 1
|
|||||||
candidate for that project (RC1)
|
candidate for that project (RC1)
|
||||||
- used as-is as the final release
|
- used as-is as the final release
|
||||||
|
|
||||||
.. class:: colright
|
|
||||||
|
.. rst-class:: colright
|
||||||
|
|
||||||
.. image:: ./_assets/01-01-release.png
|
.. image:: ./_assets/01-01-release.png
|
||||||
|
|
||||||
----
|
----
|
||||||
@ -128,7 +130,7 @@ Release candidate 1
|
|||||||
Other release candidates
|
Other release candidates
|
||||||
========================
|
========================
|
||||||
|
|
||||||
.. class:: colleft
|
.. rst-class:: colleft
|
||||||
|
|
||||||
- regressions and integration issues
|
- regressions and integration issues
|
||||||
- new release-critical bugs
|
- new release-critical bugs
|
||||||
@ -136,7 +138,8 @@ Other release candidates
|
|||||||
- merged in the master branch first
|
- merged in the master branch first
|
||||||
- repeated as many times as necessary
|
- repeated as many times as necessary
|
||||||
|
|
||||||
.. class:: colright
|
.. rst-class:: colright
|
||||||
|
|
||||||
.. image:: ./_assets/01-01-release.png
|
.. image:: ./_assets/01-01-release.png
|
||||||
|
|
||||||
----
|
----
|
||||||
@ -144,12 +147,13 @@ Other release candidates
|
|||||||
Release day
|
Release day
|
||||||
===========
|
===========
|
||||||
|
|
||||||
.. class:: colleft
|
.. rst-class:: colleft
|
||||||
|
|
||||||
- last published release candidate
|
- last published release candidate
|
||||||
- published collectively as the OpenStack release
|
- published collectively as the OpenStack release
|
||||||
|
|
||||||
.. class:: colright
|
.. rst-class:: colright
|
||||||
|
|
||||||
.. image:: ./_assets/01-01-release.png
|
.. image:: ./_assets/01-01-release.png
|
||||||
|
|
||||||
----
|
----
|
@ -1,3 +1,12 @@
|
|||||||
|
===============
|
||||||
|
Relevant actors
|
||||||
|
===============
|
||||||
|
|
||||||
|
<teacher name>
|
||||||
|
<date>
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
Relevant actors
|
Relevant actors
|
||||||
===============
|
===============
|
||||||
|
|
||||||
@ -9,9 +18,7 @@ Relevant actors
|
|||||||
Relevance metrics
|
Relevance metrics
|
||||||
=================
|
=================
|
||||||
|
|
||||||
.. image:: ./_assets/02-02-relevance-metrics.png
|
.. rst-class:: colleft
|
||||||
:align: right
|
|
||||||
:width: 55%
|
|
||||||
|
|
||||||
- Commits
|
- Commits
|
||||||
- Completed blueprints
|
- Completed blueprints
|
||||||
@ -21,6 +28,11 @@ Relevance metrics
|
|||||||
- Reviews
|
- Reviews
|
||||||
- Mentoring
|
- Mentoring
|
||||||
|
|
||||||
|
.. rst-class:: colright
|
||||||
|
|
||||||
|
.. image:: ./_assets/02-02-relevance-metrics.png
|
||||||
|
|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
Company snapshot
|
Company snapshot
|
@ -1,10 +1,7 @@
|
|||||||
|
=============================
|
||||||
OpenStack Technical Committee
|
OpenStack Technical Committee
|
||||||
=============================
|
=============================
|
||||||
|
|
||||||
|
|
|
||||||
|
|
||||||
-----
|
|
||||||
|
|
||||||
Technical Committee
|
Technical Committee
|
||||||
===================
|
===================
|
||||||
|
|
@ -1,9 +1,7 @@
|
|||||||
|
===========================
|
||||||
OpenStack Program Ecosystem
|
OpenStack Program Ecosystem
|
||||||
===========================
|
===========================
|
||||||
|
|
||||||
|
|
|
||||||
|
|
||||||
----
|
|
||||||
|
|
||||||
Lifecycle of a new Program
|
Lifecycle of a new Program
|
||||||
==========================
|
==========================
|
@ -1,13 +1,7 @@
|
|||||||
|
=======================
|
||||||
OpenStack Design Summit
|
OpenStack Design Summit
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
|
|
|
||||||
|
|
||||||
----
|
|
||||||
|
|
||||||
Design Summit
|
|
||||||
=============
|
|
||||||
|
|
||||||
Where developers meet face to face to finalize planning for the next release
|
Where developers meet face to face to finalize planning for the next release
|
||||||
cycle.
|
cycle.
|
||||||
|
|
@ -1,3 +1,4 @@
|
|||||||
|
============
|
||||||
IRC meetings
|
IRC meetings
|
||||||
============
|
============
|
||||||
|
|
@ -1,3 +1,4 @@
|
|||||||
|
============
|
||||||
devstack.org
|
devstack.org
|
||||||
============
|
============
|
||||||
|
|
@ -1,3 +1,4 @@
|
|||||||
|
=====================
|
||||||
http://launchpad.net/
|
http://launchpad.net/
|
||||||
=====================
|
=====================
|
||||||
|
|
@ -1,3 +1,4 @@
|
|||||||
|
====================
|
||||||
review.openstack.org
|
review.openstack.org
|
||||||
====================
|
====================
|
||||||
|
|
@ -1,3 +1,4 @@
|
|||||||
|
=============
|
||||||
nvie inspired
|
nvie inspired
|
||||||
=============
|
=============
|
||||||
|
|
@ -1,3 +1,4 @@
|
|||||||
|
==============
|
||||||
Review unified
|
Review unified
|
||||||
==============
|
==============
|
||||||
|
|
@ -1,3 +1,4 @@
|
|||||||
|
===============
|
||||||
Commit messages
|
Commit messages
|
||||||
===============
|
===============
|
||||||
|
|
@ -1,3 +1,4 @@
|
|||||||
|
=========================
|
||||||
Triggered on every commit
|
Triggered on every commit
|
||||||
=========================
|
=========================
|
||||||
|
|
@ -1,3 +1,4 @@
|
|||||||
|
====================================
|
||||||
Overview of the contribution process
|
Overview of the contribution process
|
||||||
====================================
|
====================================
|
||||||
|
|
@ -1,9 +1,10 @@
|
|||||||
|
===========================================
|
||||||
Lego applied to Free Software contributions
|
Lego applied to Free Software contributions
|
||||||
===========================================
|
===========================================
|
||||||
|
|
||||||
|
|
|
|
||||||
|
|
||||||
----
|
=======
|
||||||
|
|
||||||
Agile manifesto
|
Agile manifesto
|
||||||
===============
|
===============
|
||||||
@ -97,14 +98,16 @@ Communication
|
|||||||
|
|
||||||
|
|
|
|
||||||
|
|
||||||
----
|
=======
|
||||||
|
|
||||||
Diplomacy
|
Diplomacy
|
||||||
=========
|
=========
|
||||||
|
|
||||||
|
|
|
|
||||||
|
|
||||||
----
|
=======
|
||||||
|
|
||||||
Time to play with Legos
|
Time to play with Legos
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
|
|
|
184
doc/upstream-training/source/Makefile
Normal file
@ -0,0 +1,184 @@
|
|||||||
|
# Makefile for Sphinx documentation
|
||||||
|
#
|
||||||
|
|
||||||
|
# You can set these variables from the command line.
|
||||||
|
SPHINXOPTS =
|
||||||
|
SPHINXBUILD = sphinx-build
|
||||||
|
PAPER =
|
||||||
|
BUILDDIR = ../_build
|
||||||
|
|
||||||
|
# User-friendly check for sphinx-build
|
||||||
|
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
|
||||||
|
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
|
||||||
|
endif
|
||||||
|
|
||||||
|
# Internal variables.
|
||||||
|
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||||
|
PAPEROPT_letter = -D latex_paper_size=letter
|
||||||
|
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||||
|
# the i18n builder cannot share the environment and doctrees with the others
|
||||||
|
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||||
|
|
||||||
|
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
|
||||||
|
|
||||||
|
help:
|
||||||
|
@echo "Please use \`make <target>' where <target> is one of"
|
||||||
|
@echo " html to make standalone HTML files"
|
||||||
|
@echo " dirhtml to make HTML files named index.html in directories"
|
||||||
|
@echo " singlehtml to make a single large HTML file"
|
||||||
|
@echo " pickle to make pickle files"
|
||||||
|
@echo " json to make JSON files"
|
||||||
|
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||||
|
@echo " qthelp to make HTML files and a qthelp project"
|
||||||
|
@echo " devhelp to make HTML files and a Devhelp project"
|
||||||
|
@echo " epub to make an epub"
|
||||||
|
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||||
|
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||||
|
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
||||||
|
@echo " text to make text files"
|
||||||
|
@echo " man to make manual pages"
|
||||||
|
@echo " texinfo to make Texinfo files"
|
||||||
|
@echo " info to make Texinfo files and run them through makeinfo"
|
||||||
|
@echo " gettext to make PO message catalogs"
|
||||||
|
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||||
|
@echo " xml to make Docutils-native XML files"
|
||||||
|
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
||||||
|
@echo " linkcheck to check all external links for integrity"
|
||||||
|
@echo " slides to create presentation slides HTML5"
|
||||||
|
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||||
|
|
||||||
|
clean:
|
||||||
|
rm -rf $(BUILDDIR)/*
|
||||||
|
|
||||||
|
html:
|
||||||
|
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||||
|
|
||||||
|
dirhtml:
|
||||||
|
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||||
|
|
||||||
|
singlehtml:
|
||||||
|
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||||
|
|
||||||
|
pickle:
|
||||||
|
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; now you can process the pickle files."
|
||||||
|
|
||||||
|
json:
|
||||||
|
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; now you can process the JSON files."
|
||||||
|
|
||||||
|
htmlhelp:
|
||||||
|
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||||
|
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||||
|
|
||||||
|
qthelp:
|
||||||
|
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||||
|
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||||
|
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OpenStackUpstreamTraining.qhcp"
|
||||||
|
@echo "To view the help file:"
|
||||||
|
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenStackUpstreamTraining.qhc"
|
||||||
|
|
||||||
|
devhelp:
|
||||||
|
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||||
|
@echo
|
||||||
|
@echo "Build finished."
|
||||||
|
@echo "To view the help file:"
|
||||||
|
@echo "# mkdir -p $$HOME/.local/share/devhelp/OpenStackUpstreamTraining"
|
||||||
|
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenStackUpstreamTraining"
|
||||||
|
@echo "# devhelp"
|
||||||
|
|
||||||
|
epub:
|
||||||
|
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||||
|
|
||||||
|
latex:
|
||||||
|
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||||
|
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||||
|
"(use \`make latexpdf' here to do that automatically)."
|
||||||
|
|
||||||
|
latexpdf:
|
||||||
|
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||||
|
@echo "Running LaTeX files through pdflatex..."
|
||||||
|
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||||
|
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||||
|
|
||||||
|
latexpdfja:
|
||||||
|
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||||
|
@echo "Running LaTeX files through platex and dvipdfmx..."
|
||||||
|
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
||||||
|
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||||
|
|
||||||
|
text:
|
||||||
|
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||||
|
|
||||||
|
man:
|
||||||
|
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||||
|
|
||||||
|
texinfo:
|
||||||
|
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||||
|
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||||
|
"(use \`make info' here to do that automatically)."
|
||||||
|
|
||||||
|
info:
|
||||||
|
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||||
|
@echo "Running Texinfo files through makeinfo..."
|
||||||
|
make -C $(BUILDDIR)/texinfo info
|
||||||
|
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||||
|
|
||||||
|
gettext:
|
||||||
|
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||||
|
|
||||||
|
changes:
|
||||||
|
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||||
|
@echo
|
||||||
|
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||||
|
|
||||||
|
linkcheck:
|
||||||
|
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||||
|
@echo
|
||||||
|
@echo "Link check complete; look for any errors in the above output " \
|
||||||
|
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||||
|
|
||||||
|
doctest:
|
||||||
|
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||||
|
@echo "Testing of doctests in the sources finished, look at the " \
|
||||||
|
"results in $(BUILDDIR)/doctest/output.txt."
|
||||||
|
|
||||||
|
xml:
|
||||||
|
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
||||||
|
|
||||||
|
pseudoxml:
|
||||||
|
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
||||||
|
|
||||||
|
|
||||||
|
slides:
|
||||||
|
$(SPHINXBUILD) -b slides $(ALLSPHINXOPTS) $(BUILDDIR)/slides
|
||||||
|
@echo "Build finished. The HTML slides are in $(BUILDDIR)/slides."
|
||||||
|
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 54 KiB |
Before Width: | Height: | Size: 83 KiB After Width: | Height: | Size: 83 KiB |
Before Width: | Height: | Size: 90 KiB After Width: | Height: | Size: 90 KiB |
Before Width: | Height: | Size: 55 KiB After Width: | Height: | Size: 55 KiB |
Before Width: | Height: | Size: 90 KiB After Width: | Height: | Size: 90 KiB |
Before Width: | Height: | Size: 98 KiB After Width: | Height: | Size: 98 KiB |
Before Width: | Height: | Size: 133 KiB After Width: | Height: | Size: 133 KiB |
Before Width: | Height: | Size: 257 KiB After Width: | Height: | Size: 257 KiB |
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 54 KiB |
Before Width: | Height: | Size: 156 KiB After Width: | Height: | Size: 156 KiB |
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 45 KiB |
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 45 KiB |
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 45 KiB |
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 45 KiB |
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 38 KiB |
Before Width: | Height: | Size: 82 KiB After Width: | Height: | Size: 82 KiB |
Before Width: | Height: | Size: 85 KiB After Width: | Height: | Size: 85 KiB |
Before Width: | Height: | Size: 668 KiB After Width: | Height: | Size: 668 KiB |
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
Before Width: | Height: | Size: 93 KiB After Width: | Height: | Size: 93 KiB |
Before Width: | Height: | Size: 157 KiB After Width: | Height: | Size: 157 KiB |
Before Width: | Height: | Size: 47 KiB After Width: | Height: | Size: 47 KiB |
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 60 KiB |
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 44 KiB |
Before Width: | Height: | Size: 61 KiB After Width: | Height: | Size: 61 KiB |
Before Width: | Height: | Size: 174 KiB After Width: | Height: | Size: 174 KiB |
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
Before Width: | Height: | Size: 69 KiB After Width: | Height: | Size: 69 KiB |
Before Width: | Height: | Size: 64 KiB After Width: | Height: | Size: 64 KiB |
Before Width: | Height: | Size: 176 KiB After Width: | Height: | Size: 176 KiB |
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 25 KiB |
Before Width: | Height: | Size: 47 KiB After Width: | Height: | Size: 47 KiB |
Before Width: | Height: | Size: 100 KiB After Width: | Height: | Size: 100 KiB |
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 51 KiB |
Before Width: | Height: | Size: 93 KiB After Width: | Height: | Size: 93 KiB |
Before Width: | Height: | Size: 184 KiB After Width: | Height: | Size: 184 KiB |
Before Width: | Height: | Size: 75 KiB After Width: | Height: | Size: 75 KiB |
Before Width: | Height: | Size: 78 KiB After Width: | Height: | Size: 78 KiB |
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 44 KiB |
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 39 KiB |
Before Width: | Height: | Size: 57 KiB After Width: | Height: | Size: 57 KiB |
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 34 KiB |
Before Width: | Height: | Size: 83 KiB After Width: | Height: | Size: 83 KiB |
Before Width: | Height: | Size: 117 KiB After Width: | Height: | Size: 117 KiB |
Before Width: | Height: | Size: 96 KiB After Width: | Height: | Size: 96 KiB |
Before Width: | Height: | Size: 84 KiB After Width: | Height: | Size: 84 KiB |
Before Width: | Height: | Size: 88 KiB After Width: | Height: | Size: 88 KiB |
Before Width: | Height: | Size: 126 KiB After Width: | Height: | Size: 126 KiB |
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 28 KiB |
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 60 KiB |
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 43 KiB |
Before Width: | Height: | Size: 57 KiB After Width: | Height: | Size: 57 KiB |
Before Width: | Height: | Size: 89 KiB After Width: | Height: | Size: 89 KiB |
Before Width: | Height: | Size: 64 KiB After Width: | Height: | Size: 64 KiB |
Before Width: | Height: | Size: 86 KiB After Width: | Height: | Size: 86 KiB |
Before Width: | Height: | Size: 290 KiB After Width: | Height: | Size: 290 KiB |
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 46 KiB |
Before Width: | Height: | Size: 80 KiB After Width: | Height: | Size: 80 KiB |
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 31 KiB |
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 38 KiB |
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
Before Width: | Height: | Size: 82 KiB After Width: | Height: | Size: 82 KiB |
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 27 KiB |
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
Before Width: | Height: | Size: 81 KiB After Width: | Height: | Size: 81 KiB |
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 43 KiB |
Before Width: | Height: | Size: 90 KiB After Width: | Height: | Size: 90 KiB |
Before Width: | Height: | Size: 91 KiB After Width: | Height: | Size: 91 KiB |
Before Width: | Height: | Size: 114 KiB After Width: | Height: | Size: 114 KiB |
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 58 KiB |
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 51 KiB |
Before Width: | Height: | Size: 103 KiB After Width: | Height: | Size: 103 KiB |
34
doc/upstream-training/source/_static/custom.css
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
.slide {
|
||||||
|
background: -webkit-gradient(linear, left bottom, left top, from(#eef3f5), to(#fff));
|
||||||
|
background-color: #eee;
|
||||||
|
background: -moz-linear-gradient(bottom, #eef3f5, #fff);
|
||||||
|
-webkit-transition: margin 0.25s ease-in-out;
|
||||||
|
-moz-transition: margin 0.25s ease-in-out;
|
||||||
|
-o-transition: margin 0.25s ease-in-out;
|
||||||
|
border-top-left-radius: 20px;
|
||||||
|
-moz-border-radius-topleft: 20px;
|
||||||
|
-webkit-border-top-left-radius: 20px;
|
||||||
|
border-top-right-radius: 20px;
|
||||||
|
-moz-border-radius-topright: 20px;
|
||||||
|
-webkit-border-top-right-radius: 20px;
|
||||||
|
border-bottom-right-radius: 20px;
|
||||||
|
-moz-border-radius-bottomright: 20px;
|
||||||
|
-webkit-border-bottom-right-radius: 20px;
|
||||||
|
border-bottom-left-radius: 20px;
|
||||||
|
-moz-border-radius-bottomleft: 20px;
|
||||||
|
-webkit-border-bottom-left-radius: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.colleft {
|
||||||
|
float: left;
|
||||||
|
max-width: 48%;
|
||||||
|
height: 600px;
|
||||||
|
padding-left: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.colright {
|
||||||
|
float: right;
|
||||||
|
max-width: 48%;
|
||||||
|
height: 600px;
|
||||||
|
padding: 0;
|
||||||
|
}
|
291
doc/upstream-training/source/conf.py
Normal file
@ -0,0 +1,291 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
#
|
||||||
|
# OpenStack Upstream Training documentation build configuration file, created by
|
||||||
|
# sphinx-quickstart on Sat Nov 1 14:32:31 2014.
|
||||||
|
#
|
||||||
|
# This file is execfile()d with the current directory set to its
|
||||||
|
# containing dir.
|
||||||
|
#
|
||||||
|
# Note that not all possible configuration values are present in this
|
||||||
|
# autogenerated file.
|
||||||
|
#
|
||||||
|
# All configuration values have a default; values that are commented out
|
||||||
|
# serve to show the default.
|
||||||
|
|
||||||
|
import sys
|
||||||
|
import os
|
||||||
|
|
||||||
|
# If extensions (or modules to document with autodoc) are in another directory,
|
||||||
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||||
|
#sys.path.insert(0, os.path.abspath('.'))
|
||||||
|
|
||||||
|
# -- General configuration ------------------------------------------------
|
||||||
|
|
||||||
|
# If your documentation needs a minimal Sphinx version, state it here.
|
||||||
|
#needs_sphinx = '1.0'
|
||||||
|
|
||||||
|
# Add any Sphinx extension module names here, as strings. They can be
|
||||||
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||||
|
# ones.
|
||||||
|
extensions = [
|
||||||
|
'sphinx.ext.doctest',
|
||||||
|
'sphinx.ext.intersphinx',
|
||||||
|
'sphinx.ext.todo',
|
||||||
|
'sphinx.ext.coverage',
|
||||||
|
'sphinx.ext.pngmath',
|
||||||
|
'sphinx.ext.ifconfig',
|
||||||
|
]
|
||||||
|
|
||||||
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
|
templates_path = ['_templates']
|
||||||
|
|
||||||
|
# The suffix of source filenames.
|
||||||
|
source_suffix = '.rst'
|
||||||
|
|
||||||
|
# The encoding of source files.
|
||||||
|
#source_encoding = 'utf-8-sig'
|
||||||
|
|
||||||
|
# The master toctree document.
|
||||||
|
master_doc = 'index'
|
||||||
|
|
||||||
|
# General information about the project.
|
||||||
|
project = u'OpenStack Upstream Training'
|
||||||
|
copyright = u'2014, Loic, Stefano and others'
|
||||||
|
|
||||||
|
# The version info for the project you're documenting, acts as replacement for
|
||||||
|
# |version| and |release|, also used in various other places throughout the
|
||||||
|
# built documents.
|
||||||
|
#
|
||||||
|
# The short X.Y version.
|
||||||
|
version = '2014.11.01'
|
||||||
|
# The full version, including alpha/beta/rc tags.
|
||||||
|
release = '2014.11.01'
|
||||||
|
|
||||||
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
|
# for a list of supported languages.
|
||||||
|
#language = None
|
||||||
|
|
||||||
|
# There are two options for replacing |today|: either, you set today to some
|
||||||
|
# non-false value, then it is used:
|
||||||
|
#today = ''
|
||||||
|
# Else, today_fmt is used as the format for a strftime call.
|
||||||
|
#today_fmt = '%B %d, %Y'
|
||||||
|
|
||||||
|
# List of patterns, relative to source directory, that match files and
|
||||||
|
# directories to ignore when looking for source files.
|
||||||
|
exclude_patterns = ['build']
|
||||||
|
|
||||||
|
# The reST default role (used for this markup: `text`) to use for all
|
||||||
|
# documents.
|
||||||
|
#default_role = None
|
||||||
|
|
||||||
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||||
|
#add_function_parentheses = True
|
||||||
|
|
||||||
|
# If true, the current module name will be prepended to all description
|
||||||
|
# unit titles (such as .. function::).
|
||||||
|
#add_module_names = True
|
||||||
|
|
||||||
|
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||||
|
# output. They are ignored by default.
|
||||||
|
#show_authors = False
|
||||||
|
|
||||||
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
|
pygments_style = 'sphinx'
|
||||||
|
|
||||||
|
# A list of ignored prefixes for module index sorting.
|
||||||
|
#modindex_common_prefix = []
|
||||||
|
|
||||||
|
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||||
|
#keep_warnings = False
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for HTML output ----------------------------------------------
|
||||||
|
|
||||||
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
|
# a list of builtin themes.
|
||||||
|
html_theme = 'default'
|
||||||
|
|
||||||
|
# Theme options are theme-specific and customize the look and feel of a theme
|
||||||
|
# further. For a list of options available for each theme, see the
|
||||||
|
# documentation.
|
||||||
|
#html_theme_options = {}
|
||||||
|
|
||||||
|
# Add any paths that contain custom themes here, relative to this directory.
|
||||||
|
#html_theme_path = []
|
||||||
|
|
||||||
|
# The name for this set of Sphinx documents. If None, it defaults to
|
||||||
|
# "<project> v<release> documentation".
|
||||||
|
#html_title = None
|
||||||
|
|
||||||
|
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||||
|
#html_short_title = None
|
||||||
|
|
||||||
|
# The name of an image file (relative to this directory) to place at the top
|
||||||
|
# of the sidebar.
|
||||||
|
#html_logo = None
|
||||||
|
|
||||||
|
# The name of an image file (within the static path) to use as favicon of the
|
||||||
|
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||||
|
# pixels large.
|
||||||
|
#html_favicon = None
|
||||||
|
|
||||||
|
# Add any paths that contain custom static files (such as style sheets) here,
|
||||||
|
# relative to this directory. They are copied after the builtin static files,
|
||||||
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||||
|
html_static_path = ['_static']
|
||||||
|
|
||||||
|
# Add any extra paths that contain custom files (such as robots.txt or
|
||||||
|
# .htaccess) here, relative to this directory. These files are copied
|
||||||
|
# directly to the root of the documentation.
|
||||||
|
#html_extra_path = []
|
||||||
|
|
||||||
|
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||||
|
# using the given strftime format.
|
||||||
|
#html_last_updated_fmt = '%b %d, %Y'
|
||||||
|
|
||||||
|
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||||
|
# typographically correct entities.
|
||||||
|
#html_use_smartypants = True
|
||||||
|
|
||||||
|
# Custom sidebar templates, maps document names to template names.
|
||||||
|
#html_sidebars = {}
|
||||||
|
|
||||||
|
# Additional templates that should be rendered to pages, maps page names to
|
||||||
|
# template names.
|
||||||
|
#html_additional_pages = {}
|
||||||
|
|
||||||
|
# If false, no module index is generated.
|
||||||
|
#html_domain_indices = True
|
||||||
|
|
||||||
|
# If false, no index is generated.
|
||||||
|
#html_use_index = True
|
||||||
|
|
||||||
|
# If true, the index is split into individual pages for each letter.
|
||||||
|
#html_split_index = False
|
||||||
|
|
||||||
|
# If true, links to the reST sources are added to the pages.
|
||||||
|
#html_show_sourcelink = True
|
||||||
|
|
||||||
|
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||||
|
#html_show_sphinx = True
|
||||||
|
|
||||||
|
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||||
|
#html_show_copyright = True
|
||||||
|
|
||||||
|
# If true, an OpenSearch description file will be output, and all pages will
|
||||||
|
# contain a <link> tag referring to it. The value of this option must be the
|
||||||
|
# base URL from which the finished HTML is served.
|
||||||
|
#html_use_opensearch = ''
|
||||||
|
|
||||||
|
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||||
|
#html_file_suffix = None
|
||||||
|
|
||||||
|
# Output file base name for HTML help builder.
|
||||||
|
htmlhelp_basename = 'OpenStackUpstreamTrainingdoc'
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for LaTeX output ---------------------------------------------
|
||||||
|
|
||||||
|
latex_elements = {
|
||||||
|
# The paper size ('letterpaper' or 'a4paper').
|
||||||
|
#'papersize': 'letterpaper',
|
||||||
|
|
||||||
|
# The font size ('10pt', '11pt' or '12pt').
|
||||||
|
#'pointsize': '10pt',
|
||||||
|
|
||||||
|
# Additional stuff for the LaTeX preamble.
|
||||||
|
#'preamble': '',
|
||||||
|
}
|
||||||
|
|
||||||
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
|
# (source start file, target name, title,
|
||||||
|
# author, documentclass [howto, manual, or own class]).
|
||||||
|
latex_documents = [
|
||||||
|
('index', 'OpenStackUpstreamTraining.tex', u'OpenStack Upstream Training Documentation',
|
||||||
|
u'Loic, Stefano and others', 'manual'),
|
||||||
|
]
|
||||||
|
|
||||||
|
# The name of an image file (relative to this directory) to place at the top of
|
||||||
|
# the title page.
|
||||||
|
#latex_logo = None
|
||||||
|
|
||||||
|
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||||
|
# not chapters.
|
||||||
|
#latex_use_parts = False
|
||||||
|
|
||||||
|
# If true, show page references after internal links.
|
||||||
|
#latex_show_pagerefs = False
|
||||||
|
|
||||||
|
# If true, show URL addresses after external links.
|
||||||
|
#latex_show_urls = False
|
||||||
|
|
||||||
|
# Documents to append as an appendix to all manuals.
|
||||||
|
#latex_appendices = []
|
||||||
|
|
||||||
|
# If false, no module index is generated.
|
||||||
|
#latex_domain_indices = True
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for manual page output ---------------------------------------
|
||||||
|
|
||||||
|
# One entry per manual page. List of tuples
|
||||||
|
# (source start file, name, description, authors, manual section).
|
||||||
|
#man_pages = [
|
||||||
|
# ('index', 'openstackupstreamtraining', u'OpenStack Upstream Training Documentation',
|
||||||
|
# [u'Loic, Stefano and others'], 1)
|
||||||
|
#]
|
||||||
|
|
||||||
|
# If true, show URL addresses after external links.
|
||||||
|
#man_show_urls = False
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for Texinfo output -------------------------------------------
|
||||||
|
|
||||||
|
# Grouping the document tree into Texinfo files. List of tuples
|
||||||
|
# (source start file, target name, title, author,
|
||||||
|
# dir menu entry, description, category)
|
||||||
|
#texinfo_documents = [
|
||||||
|
# ('index', 'OpenStackUpstreamTraining', u'OpenStack Upstream Training Documentation',
|
||||||
|
# u'Loic, Stefano and others', 'OpenStackUpstreamTraining', 'One line description of project.',
|
||||||
|
# 'Miscellaneous'),
|
||||||
|
#]
|
||||||
|
|
||||||
|
# Documents to append as an appendix to all manuals.
|
||||||
|
#texinfo_appendices = []
|
||||||
|
|
||||||
|
# If false, no module index is generated.
|
||||||
|
#texinfo_domain_indices = True
|
||||||
|
|
||||||
|
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||||
|
#texinfo_show_urls = 'footnote'
|
||||||
|
|
||||||
|
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||||
|
#texinfo_no_detailmenu = False
|
||||||
|
|
||||||
|
|
||||||
|
# -- Hieroglyph Slide Configuration ------------
|
||||||
|
|
||||||
|
extensions += [
|
||||||
|
'hieroglyph',
|
||||||
|
]
|
||||||
|
|
||||||
|
#slide_theme = 'slides'
|
||||||
|
slide_theme = 'single-level'
|
||||||
|
slide_levels = 3
|
||||||
|
|
||||||
|
# Place custom static assets in the _static directory and uncomment
|
||||||
|
# the following lines to include them
|
||||||
|
|
||||||
|
slide_theme_options = {
|
||||||
|
'custom_css': 'custom.css',
|
||||||
|
}
|
||||||
|
#'custom_js': 'custom.js',
|
||||||
|
|
||||||
|
# ----------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Example configuration for intersphinx: refer to the Python standard library.
|
||||||
|
intersphinx_mapping = {'http://docs.python.org/': None}
|
37
doc/upstream-training/source/index.rst
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
.. Upstream Training documentation master file, created by
|
||||||
|
sphinx-quickstart on Sat Nov 1 12:04:55 2014.
|
||||||
|
You can adapt this file completely to your liking, but it should at least
|
||||||
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
|
Welcome to Upstream Training's documentation!
|
||||||
|
=============================================
|
||||||
|
|
||||||
|
Contents:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
01-release-cycle
|
||||||
|
02-relevant-actors
|
||||||
|
03-technical-committee
|
||||||
|
04-program-ecosystem
|
||||||
|
05-design-summit
|
||||||
|
06-irc-meetings
|
||||||
|
11-devstack
|
||||||
|
12-howtocontribute
|
||||||
|
13-launchpad
|
||||||
|
14-gerrit
|
||||||
|
15-branching-model
|
||||||
|
16-reviewing
|
||||||
|
17-commit-message
|
||||||
|
18-jenkins
|
||||||
|
19-training-contribution-process
|
||||||
|
20-training-agile-for-contributors
|
||||||
|
|
||||||
|
Indices and tables
|
||||||
|
==================
|
||||||
|
|
||||||
|
* :ref:`genindex`
|
||||||
|
* :ref:`modindex`
|
||||||
|
* :ref:`search`
|
||||||
|
|
@ -1,182 +0,0 @@
|
|||||||
<!DOCTYPE html>
|
|
||||||
<!--
|
|
||||||
Copyright 2010 Google Inc.
|
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
you may not use this file except in compliance with the License.
|
|
||||||
You may obtain a copy of the License at
|
|
||||||
|
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
See the License for the specific language governing permissions and
|
|
||||||
limitations under the License.
|
|
||||||
|
|
||||||
Original slides: Marcin Wichary (mwichary@google.com)
|
|
||||||
Modifications: Ernest Delgado (ernestd@google.com)
|
|
||||||
Alex Russell (slightlyoff@chromium.org)
|
|
||||||
|
|
||||||
landslide modifications: Adam Zapletal (adamzap@gmail.com)
|
|
||||||
Nicolas Perriault (nperriault@gmail.com)
|
|
||||||
-->
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
||||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
|
||||||
<title>{{ head_title }}</title>
|
|
||||||
<!-- Styles -->
|
|
||||||
{% if embed %}
|
|
||||||
<style type="text/css" media="print">
|
|
||||||
{{ css.print.contents }}
|
|
||||||
</style>
|
|
||||||
<style type="text/css" media="screen, projection">
|
|
||||||
{{ css.screen.contents }}
|
|
||||||
</style>
|
|
||||||
{% else %}
|
|
||||||
<link rel="stylesheet" media="print" href="{{ css.print.path_url }}">
|
|
||||||
<link rel="stylesheet" media="screen, projection" href="{{ css.screen.path_url }}">
|
|
||||||
{% endif %}
|
|
||||||
{% for css in user_css %}
|
|
||||||
{% if embed %}
|
|
||||||
<style type="text/css" media="screen, projection">
|
|
||||||
{{ css.contents }}
|
|
||||||
</style>
|
|
||||||
{% else %}
|
|
||||||
<link rel="stylesheet" href="{{ css.path_url }}">
|
|
||||||
{% endif %}
|
|
||||||
{% endfor %}
|
|
||||||
<!-- /Styles -->
|
|
||||||
<!-- Javascripts -->
|
|
||||||
{% if embed %}
|
|
||||||
<script>
|
|
||||||
{{ js.contents }}
|
|
||||||
</script>
|
|
||||||
{% else %}
|
|
||||||
<script type="text/javascript" src="{{ js.path_url }}"></script>
|
|
||||||
{% endif %}
|
|
||||||
{% for js in user_js %}
|
|
||||||
{% if embed %}
|
|
||||||
<script>
|
|
||||||
{{ js.contents }}
|
|
||||||
</script>
|
|
||||||
{% else %}
|
|
||||||
<script type="text/javascript" src="{{ js.path_url }}"></script>
|
|
||||||
{% endif %}
|
|
||||||
{% endfor %}
|
|
||||||
<!-- /Javascripts -->
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div id="blank"></div>
|
|
||||||
<div class="presentation">
|
|
||||||
<div id="current_presenter_notes">
|
|
||||||
<div id="presenter_note"></div>
|
|
||||||
</div>
|
|
||||||
<div class="slides">
|
|
||||||
{% for slide in slides %}
|
|
||||||
<!-- slide source: {% if slide.source %}{{ slide.source.rel_path }}{% endif %} -->
|
|
||||||
<div class="slide-wrapper">
|
|
||||||
<div class="slide{% if slide.classes %}{% for class in slide.classes %} {{ class }}{% endfor %}{% endif %}">
|
|
||||||
<div class="inner">
|
|
||||||
{% if slide.header %}
|
|
||||||
<header>{{ slide.header }}</header>
|
|
||||||
{% endif %}
|
|
||||||
{% if slide.content %}
|
|
||||||
<section>{{ slide.content }}</section>
|
|
||||||
{% endif %}
|
|
||||||
</div>
|
|
||||||
<div class="presenter_notes">
|
|
||||||
<header><h1>Presenter Notes</h1></header>
|
|
||||||
<section>
|
|
||||||
{% if slide.presenter_notes %}
|
|
||||||
{{ slide.presenter_notes }}
|
|
||||||
{% endif %}
|
|
||||||
</section>
|
|
||||||
</div>
|
|
||||||
<footer>
|
|
||||||
{% if slide.source %}
|
|
||||||
<aside class="source">
|
|
||||||
Source: <a href="{{ slide.source.rel_path }}">{{ slide.source.rel_path }}</a>
|
|
||||||
</aside>
|
|
||||||
{% endif %}
|
|
||||||
<aside class="page_number">
|
|
||||||
{{ slide.number }}/{{ num_slides }}
|
|
||||||
</aside>
|
|
||||||
</footer>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
{% endfor %}
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
{% if toc %}
|
|
||||||
<div id="toc" class="sidebar hidden">
|
|
||||||
<h2>Table of Contents</h2>
|
|
||||||
<table>
|
|
||||||
<caption>Table of Contents</caption>
|
|
||||||
{% for section in toc %}
|
|
||||||
<tr id="toc-row-{{ section.number }}">
|
|
||||||
<th><a href="#slide{{ section.number }}">{{ section.title }}</a></th>
|
|
||||||
<td><a href="#slide{{ section.number }}">{{ section.number }}</a></td>
|
|
||||||
</tr>
|
|
||||||
{% if section.sub %}
|
|
||||||
{% for subsection in section.sub %}
|
|
||||||
<tr id="toc-row-{{ subsection.number }}" class="sub">
|
|
||||||
<th><a href="#slide{{ subsection.number }}">{{ subsection.title }}</a></th>
|
|
||||||
<td><a href="#slide{{ subsection.number }}">{{ subsection.number }}</a></td>
|
|
||||||
</tr>
|
|
||||||
{% endfor %}
|
|
||||||
{% endif %}
|
|
||||||
{% endfor %}
|
|
||||||
</table>
|
|
||||||
</div>
|
|
||||||
{% endif %}
|
|
||||||
<div id="help" class="sidebar hidden">
|
|
||||||
<h2>Help</h2>
|
|
||||||
<table>
|
|
||||||
<caption>Help</caption>
|
|
||||||
<tr>
|
|
||||||
<th>Table of Contents</th>
|
|
||||||
<td>t</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>Exposé</th>
|
|
||||||
<td>ESC</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>Full screen slides</th>
|
|
||||||
<td>e</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>Presenter View</th>
|
|
||||||
<td>p</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>Source Files</th>
|
|
||||||
<td>s</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>Slide Numbers</th>
|
|
||||||
<td>n</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>Toggle screen blanking</th>
|
|
||||||
<td>b</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>Show/hide slide context</th>
|
|
||||||
<td>c</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>Notes</th>
|
|
||||||
<td>2</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<th>Help</th>
|
|
||||||
<td>h</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
</div>
|
|
||||||
<script>main()</script>
|
|
||||||
</body>
|
|
||||||
</html>
|
|