Merge branch 'master' of gitorious.org:mediagoblin/mediagoblin

docs/Makefile

@@ -5,17 +5,16 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = _build
+BUILDDIR      = build
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 # the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+.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"
@@ -35,6 +34,9 @@ help:
 	@echo "  changes    to make an overview of all changed/added/deprecated items"
 	@echo "  linkcheck  to check all external links for integrity"
 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
 
 clean:
 	-rm -rf $(BUILDDIR)/*

docs/source/_templates/mg_theme/layout.html

@@ -0,0 +1,39 @@
+{#
+    default/layout.html
+    ~~~~~~~~~~~~~~~~~~~
+
+    Sphinx layout template for the default theme.
+
+    :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{% extends "basic/layout.html" %}
+
+{% if theme_collapsiblesidebar|tobool %}
+{% set script_files = script_files + ['_static/sidebar.js'] %}
+{% endif %}
+
+{%- block footer %}
+    <div class="footer">
+    <div>
+    {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
+    {%- if last_updated %}
+      {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
+    {%- endif %}
+    {% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
+    </div>
+<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by-sa/3.0/88x31.png" /></a><br /><span xmlns:dc="http://purl.org/dc/elements/1.1/" href="http://purl.org/dc/dcmitype/Text" property="dc:title" rel="dc:type">{{ shorttitle|e }}</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="http://bluesock.org/~willg/" property="cc:attributionName" rel="cc:attributionURL">Will Kahn-Greene</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons Attribution-ShareAlike 3.0 Unported License</a>.<br />
+    </div>
+
+<script type="text/javascript">
+  var _gaq = _gaq || [];
+  _gaq.push(['_setAccount', 'UA-163840-8']);
+  _gaq.push(['_trackPageview']);
+
+  (function() {
+    var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+  })();
+</script>
+{%- endblock %}

docs/source/_templates/mg_theme/static/default.css_t

@@ -0,0 +1,299 @@
+/*
+ * default.css_t
+ * ~~~~~~~~~~~~~
+ *
+ * Sphinx stylesheet -- default theme.
+ *
+ * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+@import url("basic.css");
+
+/* -- page layout ----------------------------------------------------------- */
+
+body {
+    font-family: {{ theme_bodyfont }};
+    font-size: 100%;
+    background-color: {{ theme_footerbgcolor }};
+    color: #000;
+    margin: 0;
+    padding: 0;
+}
+
+div.document {
+    background-color: {{ theme_sidebarbgcolor }};
+}
+
+div.documentwrapper {
+    float: left;
+    width: 100%;
+}
+
+div.bodywrapper {
+    margin: 0 0 0 230px;
+}
+
+div.body {
+    background-color: {{ theme_bgcolor }};
+    color: {{ theme_textcolor }};
+    padding: 0 20px 30px 20px;
+}
+
+{%- if theme_rightsidebar|tobool %}
+div.bodywrapper {
+    margin: 0 230px 0 0;
+}
+{%- endif %}
+
+div.footer {
+    color: {{ theme_footertextcolor }};
+    width: 100%;
+    padding: 9px 0 9px 0;
+    text-align: center;
+    font-size: 75%;
+}
+
+div.footer a {
+    color: {{ theme_footertextcolor }};
+    text-decoration: underline;
+}
+
+div.related {
+    background-color: {{ theme_relbarbgcolor }};
+    line-height: 30px;
+    color: {{ theme_relbartextcolor }};
+}
+
+div.related a {
+    color: {{ theme_relbarlinkcolor }};
+}
+
+div.sphinxsidebar {
+    {%- if theme_stickysidebar|tobool %}
+    top: 30px;
+    bottom: 0;
+    margin: 0;
+    position: fixed;
+    overflow: auto;
+    height: auto;
+    {%- endif %}
+    {%- if theme_rightsidebar|tobool %}
+    float: right;
+    {%- if theme_stickysidebar|tobool %}
+    right: 0;
+    {%- endif %}
+    {%- endif %}
+}
+
+{%- if theme_stickysidebar|tobool %}
+/* this is nice, but it it leads to hidden headings when jumping
+   to an anchor */
+/*
+div.related {
+    position: fixed;
+}
+
+div.documentwrapper {
+    margin-top: 30px;
+}
+*/
+{%- endif %}
+
+div.sphinxsidebar h3 {
+    font-family: {{ theme_headfont }};
+    color: {{ theme_sidebartextcolor }};
+    font-size: 1.4em;
+    font-weight: normal;
+    margin: 0;
+    padding: 0;
+}
+
+div.sphinxsidebar h3 a {
+    color: {{ theme_sidebartextcolor }};
+}
+
+div.sphinxsidebar h4 {
+    font-family: {{ theme_headfont }};
+    color: {{ theme_sidebartextcolor }};
+    font-size: 1.3em;
+    font-weight: normal;
+    margin: 5px 0 0 0;
+    padding: 0;
+}
+
+div.sphinxsidebar p {
+    color: {{ theme_sidebartextcolor }};
+}
+
+div.sphinxsidebar p.topless {
+    margin: 5px 10px 10px 10px;
+}
+
+div.sphinxsidebar ul {
+    margin: 10px;
+    padding: 0;
+    color: {{ theme_sidebartextcolor }};
+}
+
+div.sphinxsidebar a {
+    color: {{ theme_sidebarlinkcolor }};
+}
+
+div.sphinxsidebar input {
+    border: 1px solid {{ theme_sidebarlinkcolor }};
+    font-family: sans-serif;
+    font-size: 1em;
+}
+
+
+/* -- hyperlink styles ------------------------------------------------------ */
+
+a {
+    color: {{ theme_linkcolor }};
+    text-decoration: none;
+}
+
+a:visited {
+    color: {{ theme_visitedlinkcolor }};
+    text-decoration: none;
+}
+
+a:hover {
+    text-decoration: underline;
+}
+
+{% if theme_externalrefs|tobool %}
+a.external {
+   text-decoration: none;
+   border-bottom: 1px dashed {{ theme_linkcolor }};
+}
+
+a.external:hover {
+   text-decoration: none;
+   border-bottom: none;
+}
+{% endif %}
+
+/* -- body styles ----------------------------------------------------------- */
+
+div.body h1,
+div.body h2,
+div.body h3,
+div.body h4,
+div.body h5,
+div.body h6 {
+    font-family: {{ theme_headfont }};
+    background-color: {{ theme_headbgcolor }};
+    font-weight: normal;
+    color: {{ theme_headtextcolor }};
+    border-bottom: 1px solid #ccc;
+    margin: 20px -20px 10px -20px;
+    padding: 3px 0 3px 10px;
+}
+
+div.body h1 { margin-top: 0; font-size: 200%; }
+div.body h2 { font-size: 160%; }
+div.body h3 { font-size: 140%; }
+div.body h4 { font-size: 120%; }
+div.body h5 { font-size: 110%; }
+div.body h6 { font-size: 100%; }
+
+a.headerlink {
+    color: {{ theme_headlinkcolor }};
+    font-size: 0.8em;
+    padding: 0 4px 0 4px;
+    text-decoration: none;
+}
+
+a.headerlink:hover {
+    background-color: {{ theme_headlinkcolor }};
+    color: white;
+}
+
+div.body p, div.body dd, div.body li {
+    text-align: justify;
+    line-height: 130%;
+}
+
+div.admonition p.admonition-title + p {
+    display: inline;
+}
+
+div.admonition p {
+    margin-bottom: 5px;
+}
+
+div.admonition pre {
+    margin-bottom: 5px;
+}
+
+div.admonition ul, div.admonition ol {
+    margin-bottom: 5px;
+}
+
+div.note {
+    background-color: #eee;
+    border: 1px solid #ccc;
+}
+
+div.seealso {
+    background-color: #ffc;
+    border: 1px solid #ff6;
+}
+
+div.topic {
+    background-color: #eee;
+}
+
+div.warning {
+    background-color: #ffe4e4;
+    border: 1px solid #f66;
+}
+
+p.admonition-title {
+    display: inline;
+}
+
+p.admonition-title:after {
+    content: ":";
+}
+
+pre {
+    padding: 5px;
+    background-color: {{ theme_codebgcolor }};
+    color: {{ theme_codetextcolor }};
+    line-height: 120%;
+    border: 1px solid #ac9;
+    border-left: none;
+    border-right: none;
+}
+
+tt {
+    background-color: #ecf0f3;
+    padding: 0 1px 0 1px;
+    font-size: 0.95em;
+}
+
+th {
+    background-color: #ede;
+}
+
+.warning tt {
+    background: #efc2c2;
+}
+
+.note tt {
+    background: #d6d6d6;
+}
+
+.viewcode-back {
+    font-family: {{ theme_bodyfont }};
+}
+
+div.viewcode-block:target {
+    background-color: #f4debf;
+    border-top: 1px solid #ac9;
+    border-bottom: 1px solid #ac9;
+}

docs/source/_templates/mg_theme/theme.conf

@@ -0,0 +1,31 @@
+[theme]
+inherit = basic
+stylesheet = default.css
+pygments_style = sphinx
+
+[options]
+rightsidebar = false
+stickysidebar = false
+collapsiblesidebar = false
+externalrefs = false
+
+footerbgcolor    = #b11818
+footertextcolor  = #ffffff
+sidebarbgcolor   = #6a0000
+sidebartextcolor = #ffffff
+sidebarlinkcolor = #98dbcc
+relbarbgcolor    = #b11818
+relbartextcolor  = #ffffff
+relbarlinkcolor  = #ffffff
+bgcolor          = #ffffff
+textcolor        = #000000
+headbgcolor      = #fdeded
+headtextcolor    = #20435c
+headlinkcolor    = #c60f0f
+linkcolor        = #355f7c
+visitedlinkcolor = #355f7c
+codebgcolor      = #eeffcc
+codetextcolor    = #333333
+
+bodyfont = sans-serif
+headfont = 'Trebuchet MS', sans-serif

docs/source/conf.py

@@ -64,7 +64,7 @@ release = '0.0.3'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ['_build', 'mgext', '_templates', '_static']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None

maketarball.sh

@@ -17,60 +17,159 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
-# usage: maketarball [-d] <rev-ish>
+# usage: maketarball [-drh] REVISH
 #
-# Creates a tarball from a rev-ish.  If -d is passed in, then it adds
-# the date to the directory name.
+# Creates a tarball of the repository at rev REVISH.
+
+# If -d is passed in, then it adds the date to the directory name.
+# 
+# If -r is passed in, then it does some additional things required
+# for a release-ready tarball.
+#
+# If -h is passed in, shows help and exits.
 #
 # Examples:
 #
-#    ./maketarball -d master
 #    ./maketarball v0.0.2
+#    ./maketarball -d master
+#    ./maketarball -r v0.0.2
+
+
+USAGE="Usage: $0 -h | [-dr] REVISH"
+
+REVISH="none"
+PREFIX="none"
+NOWDATE=""
+RELEASE="no"
+
+while getopts ":dhr" opt;
+do
+    case "$opt" in
+        h)
+            echo "$USAGE"
+            echo ""
+            echo "Creates a tarball of the repository at rev REVISH."
+            echo ""
+            echo "   -h   Shows this help message"
+            echo "   -d   Includes date in tar file name and directory"
+            echo "   -r   Performs other release-related actions"
+            exit 0
+            ;;
+        d)
+            NOWDATE=`date "+%Y-%m-%d-"`
+            shift $((OPTIND-1))
+            ;;
+        r)
+            RELEASE="yes"
+            shift $((OPTIND-1))
+            ;;
+        \?)
+            echo "Invalid option: -$OPTARG" >&2
+            echo "$USAGE" >&2
+            ;;
+    esac 
+done
 
 if [[ -z "$1" ]]; then
-    echo "Usage: $0 [-d] <rev-ish>";
+    echo "$USAGE";
     exit 1;
 fi
 
-NOWDATE=`date "+%Y-%m-%d"`
+REVISH=$1
+PREFIX="$NOWDATE$REVISH"
 
-if [[ $@ == *-d* ]]; then
-    REVISH=$2
-    PREFIX="$NOWDATE-$REVISH"
-else
-    REVISH=$1
-    PREFIX="$REVISH"
-fi
-
-
-# convert PREFIX to all lowercase.
-# nix the v from tag names.
+# convert PREFIX to all lowercase and nix the v from tag names.
 PREFIX=`echo "$PREFIX" | tr '[A-Z]' '[a-z]' | sed s/v//`
 
-echo "== REVISH $REVISH"
-echo "== PREFIX $PREFIX"
+# build the filename base minus the .tar.gz stuff--this is also
+# the directory in the tarball.
+FNBASE="mediagoblin-$PREFIX"
+
+STARTDIR=`pwd`
+
+function cleanup {
+    pushd $STARTDIR
+
+    if [[ -e tmp ]]
+    then
+        echo "+ cleaning up tmp/"
+        rm -rf tmp
+    fi
+    popd
+}
+
+echo "+ Building tarball from: $REVISH"
+echo "+ Using prefix:          $PREFIX"
+echo "+ Release?:              $RELEASE"
 
 echo ""
 
-echo "generating archive...."
+if [[ -e tmp ]]
+then
+    echo "+ there's an existing tmp/.  please remove it."
+    exit 1
+fi
+
+mkdir $STARTDIR/tmp
+echo "+ generating archive...."
 git archive \
     --format=tar \
-    --prefix=mediagoblin-$PREFIX/ \
-    $REVISH > mediagoblin-$PREFIX.tar
+    --prefix=$FNBASE/ \
+    $REVISH > tmp/$FNBASE.tar
 
 if [[ $? -ne 0 ]]
 then
-    echo "git archive command failed.  See above text for reason."
-    if [[ -e mediagoblin-$PREFIX.tar ]]
-    then
-        rm mediagoblin-$PREFIX.tar
-    fi
-    exit 1;
+    echo "+ git archive command failed.  See above text for reason."
+    cleanup
+    exit 1
 fi
 
-echo "compressing...."
-gzip mediagoblin-$PREFIX.tar
 
-echo "archive at mediagoblin-$PREFIX.tar.gz"
+if [[ $RELEASE = "yes" ]]
+then
+    pushd tmp/
+    tar -xvf $FNBASE.tar
 
-echo "done."
+    pushd $FNBASE
+    pushd docs
+
+    echo "+ generating html docs"
+    make html
+    if [[ $? -ne 0 ]]
+    then
+        echo "+ sphinx docs generation failed.  See above text for reason."
+        cleanup
+        exit 1
+    fi
+
+    # NOTE: this doesn't work for gmg prior to v0.0.4.
+    echo "+ generating texinfo docs (doesn't work prior to v0.0.4)"
+    make info
+    popd
+
+    echo "+ moving docs to the right place"
+    if [[ -e docs/build/html/ ]]
+    then
+        mv docs/build/html/ docs/html/
+        mv docs/build/texinfo/ docs/texinfo/
+
+        rm -rf docs/build/
+    else
+        mv docs/_build/html/ docs/html/
+
+        rm -rf docs/_build/
+    fi
+
+    popd
+
+    tar -cvf $FNBASE.tar $FNBASE
+    popd
+fi
+
+
+echo "+ compressing...."
+gzip tmp/$FNBASE.tar
+
+echo "+ archive at tmp/$FNBASE.tar.gz"
+
+echo "+ done."