Porting presentations to Sphinx/Hieroglyph

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
changes/95/132395/13
Pranav Salunke 8 years ago committed by Matjaz Pancur
parent 191e317d84
commit f1e4bfeca8

1
.gitignore vendored

@ -7,6 +7,7 @@ target/
publish-docs/
generated/
/build-*.log.gz
build/
# Ignore Vagrant Related Files
acceptance_config.yml

@ -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 Upstream Training
---------------------------
<teacher name>
<date>
@ -12,28 +10,27 @@ OpenStack Upstream Training
Planning : Design
=================
.. class:: colleft
.. rst-class:: colleft
- Planning stage is at the start of a cycle
- take a step back
- focus on what we want to do for the next one
.. class:: colright
.. image:: ./_assets/01-01-release.png
----
Planning : Discuss
==================
.. class:: colleft
.. rst-class:: colleft
- With our peers
- feedback and comments
- create the corresponding blueprint
- 4 weeks, Design Summit on the third week
.. class:: colright
.. image:: ./_assets/01-01-release.png
----
@ -41,14 +38,15 @@ Planning : Discuss
Planning : Target
=================
.. class:: colleft
.. rst-class:: colleft
- file new blueprints and/or specs
- set a target milestone
- when in the cycle they intend to complete it
- PTLs triage the submitted blueprints and set priority
.. class:: colright
.. rst-class:: colright
.. image:: ./_assets/01-01-release.png
----
@ -56,14 +54,15 @@ Planning : Target
Implementation : Milestone
==========================
.. class:: colleft
.. rst-class:: colleft
- pushed to our Gerrit review
- weeks before the milestone publication date
- milestone-proposed branch
- feature-frozen
.. class:: colright
.. rst-class:: colright
.. image:: ./_assets/01-01-release.png
----
@ -71,32 +70,32 @@ Implementation : Milestone
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
- read: focus on bug-fixing
* new features will not be accepted, only fixes
- String freeze
* String freeze
- all externally visible strings must be frozen
- this helps the translation and documentation program
* all externally visible strings must be frozen
* this helps the translation and documentation program
.. class:: colright
.. image:: ./_assets/01-01-release.png
.. rst-class:: colright
.. image:: ./_assets/01-01-release.png
----
Release Candidates
==================
.. class:: colleft
.. rst-class:: colleft
- After the last milestone
- file bugs about everything you find
@ -104,7 +103,8 @@ Release Candidates
- write documentation
- fix as many bugs as you can
.. class:: colright
.. rst-class:: colright
.. image:: ./_assets/01-01-release.png
----
@ -112,7 +112,7 @@ Release Candidates
Release candidate 1
===================
.. class:: colleft
.. rst-class:: colleft
- Between the last milestone and the RC1
- stop adding features and concentrate on bug fixes
@ -120,7 +120,9 @@ Release candidate 1
candidate for that project (RC1)
- used as-is as the final release
.. class:: colright
.. rst-class:: colright
.. image:: ./_assets/01-01-release.png
----
@ -128,7 +130,7 @@ Release candidate 1
Other release candidates
========================
.. class:: colleft
.. rst-class:: colleft
- regressions and integration issues
- new release-critical bugs
@ -136,7 +138,8 @@ Other release candidates
- merged in the master branch first
- repeated as many times as necessary
.. class:: colright
.. rst-class:: colright
.. image:: ./_assets/01-01-release.png
----
@ -144,12 +147,13 @@ Other release candidates
Release day
===========
.. class:: colleft
.. rst-class:: colleft
- last published release candidate
- published collectively as the OpenStack release
.. class:: colright
.. rst-class:: colright
.. image:: ./_assets/01-01-release.png
----

@ -1,3 +1,12 @@
===============
Relevant actors
===============
<teacher name>
<date>
----
Relevant actors
===============
@ -9,9 +18,7 @@ Relevant actors
Relevance metrics
=================
.. image:: ./_assets/02-02-relevance-metrics.png
:align: right
:width: 55%
.. rst-class:: colleft
- Commits
- Completed blueprints
@ -21,6 +28,11 @@ Relevance metrics
- Reviews
- Mentoring
.. rst-class:: colright
.. image:: ./_assets/02-02-relevance-metrics.png
----
Company snapshot

@ -1,10 +1,7 @@
=============================
OpenStack Technical Committee
=============================
|
-----
Technical Committee
===================

@ -1,9 +1,7 @@
===========================
OpenStack Program Ecosystem
===========================
|
----
Lifecycle of a new Program
==========================

@ -1,13 +1,7 @@
=======================
OpenStack Design Summit
=======================
|
----
Design Summit
=============
Where developers meet face to face to finalize planning for the next release
cycle.

@ -1,3 +1,4 @@
=====================
http://launchpad.net/
=====================

@ -1,3 +1,4 @@
====================
review.openstack.org
====================

@ -1,3 +1,4 @@
=========================
Triggered on every commit
=========================

@ -1,3 +1,4 @@
====================================
Overview of the contribution process
====================================

@ -1,9 +1,10 @@
===========================================
Lego applied to Free Software contributions
===========================================
|
----
=======
Agile manifesto
===============
@ -97,14 +98,16 @@ Communication
|
----
=======
Diplomacy
=========
|
----
=======
Time to play with Legos
=======================
|

@ -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: 69 KiB

After

Width:  |  Height:  |  Size: 69 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: 184 KiB

After

Width:  |  Height:  |  Size: 184 KiB

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 64 KiB

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 27 KiB

Before

Width:  |  Height:  |  Size: 43 KiB

After

Width:  |  Height:  |  Size: 43 KiB

Before

Width:  |  Height:  |  Size: 114 KiB

After

Width:  |  Height:  |  Size: 114 KiB

Before

Width:  |  Height:  |  Size: 103 KiB

After

Width:  |  Height:  |  Size: 103 KiB

@ -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;
}

@ -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'