aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/Makefile12
-rw-r--r--docs/source/_static/placeholder (renamed from docs/_static/placeholder)0
-rw-r--r--docs/source/_templates/mg_theme/layout.html39
-rw-r--r--docs/source/_templates/mg_theme/static/default.css_t299
-rw-r--r--docs/source/_templates/mg_theme/theme.conf31
-rw-r--r--docs/source/codebase.rst (renamed from docs/codebase.rst)0
-rw-r--r--docs/source/conf.py (renamed from docs/conf.py)2
-rw-r--r--docs/source/contributinghowto.rst (renamed from docs/contributinghowto.rst)0
-rw-r--r--docs/source/deploymenthowto.rst (renamed from docs/deploymenthowto.rst)0
-rw-r--r--docs/source/designdecisions.rst (renamed from docs/designdecisions.rst)0
-rw-r--r--docs/source/foreword.rst (renamed from docs/foreword.rst)0
-rw-r--r--docs/source/git.rst (renamed from docs/git.rst)0
-rw-r--r--docs/source/goblin.png (renamed from docs/goblin.png)bin47763 -> 47763 bytes
-rw-r--r--docs/source/hackinghowto.rst (renamed from docs/hackinghowto.rst)0
-rw-r--r--docs/source/index.rst (renamed from docs/index.rst)0
-rw-r--r--docs/source/mediagoblin.rst (renamed from docs/mediagoblin.rst)0
-rw-r--r--docs/source/mgext/__init__.py (renamed from docs/mgext/__init__.py)0
-rw-r--r--docs/source/mgext/youcanhelp.py (renamed from docs/mgext/youcanhelp.py)0
-rw-r--r--docs/source/snugglygoblin.png (renamed from docs/snugglygoblin.png)bin163754 -> 163754 bytes
-rw-r--r--docs/source/theminghowto.rst (renamed from docs/theminghowto.rst)0
-rw-r--r--docs/source/vision.rst (renamed from docs/vision.rst)0
21 files changed, 377 insertions, 6 deletions
diff --git a/docs/Makefile b/docs/Makefile
index 9a4608de..0b97bf7c 100644
--- a/docs/Makefile
+++ b/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)/*
diff --git a/docs/_static/placeholder b/docs/source/_static/placeholder
index e69de29b..e69de29b 100644
--- a/docs/_static/placeholder
+++ b/docs/source/_static/placeholder
diff --git a/docs/source/_templates/mg_theme/layout.html b/docs/source/_templates/mg_theme/layout.html
new file mode 100644
index 00000000..eccda14b
--- /dev/null
+++ b/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 %}
diff --git a/docs/source/_templates/mg_theme/static/default.css_t b/docs/source/_templates/mg_theme/static/default.css_t
new file mode 100644
index 00000000..f200a0fe
--- /dev/null
+++ b/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;
+}
diff --git a/docs/source/_templates/mg_theme/theme.conf b/docs/source/_templates/mg_theme/theme.conf
new file mode 100644
index 00000000..49442e3b
--- /dev/null
+++ b/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
diff --git a/docs/codebase.rst b/docs/source/codebase.rst
index 898eadfe..898eadfe 100644
--- a/docs/codebase.rst
+++ b/docs/source/codebase.rst
diff --git a/docs/conf.py b/docs/source/conf.py
index a7acd3e2..5861a463 100644
--- a/docs/conf.py
+++ b/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
diff --git a/docs/contributinghowto.rst b/docs/source/contributinghowto.rst
index 06d2814e..06d2814e 100644
--- a/docs/contributinghowto.rst
+++ b/docs/source/contributinghowto.rst
diff --git a/docs/deploymenthowto.rst b/docs/source/deploymenthowto.rst
index f50edfb6..f50edfb6 100644
--- a/docs/deploymenthowto.rst
+++ b/docs/source/deploymenthowto.rst
diff --git a/docs/designdecisions.rst b/docs/source/designdecisions.rst
index afa1e26b..afa1e26b 100644
--- a/docs/designdecisions.rst
+++ b/docs/source/designdecisions.rst
diff --git a/docs/foreword.rst b/docs/source/foreword.rst
index 1d423f08..1d423f08 100644
--- a/docs/foreword.rst
+++ b/docs/source/foreword.rst
diff --git a/docs/git.rst b/docs/source/git.rst
index bd0f9d52..bd0f9d52 100644
--- a/docs/git.rst
+++ b/docs/source/git.rst
diff --git a/docs/goblin.png b/docs/source/goblin.png
index e20265e6..e20265e6 100644
--- a/docs/goblin.png
+++ b/docs/source/goblin.png
Binary files differ
diff --git a/docs/hackinghowto.rst b/docs/source/hackinghowto.rst
index caafba53..caafba53 100644
--- a/docs/hackinghowto.rst
+++ b/docs/source/hackinghowto.rst
diff --git a/docs/index.rst b/docs/source/index.rst
index 2f84d6a6..2f84d6a6 100644
--- a/docs/index.rst
+++ b/docs/source/index.rst
diff --git a/docs/mediagoblin.rst b/docs/source/mediagoblin.rst
index c437ecc3..c437ecc3 100644
--- a/docs/mediagoblin.rst
+++ b/docs/source/mediagoblin.rst
diff --git a/docs/mgext/__init__.py b/docs/source/mgext/__init__.py
index e69de29b..e69de29b 100644
--- a/docs/mgext/__init__.py
+++ b/docs/source/mgext/__init__.py
diff --git a/docs/mgext/youcanhelp.py b/docs/source/mgext/youcanhelp.py
index a99d0e4d..a99d0e4d 100644
--- a/docs/mgext/youcanhelp.py
+++ b/docs/source/mgext/youcanhelp.py
diff --git a/docs/snugglygoblin.png b/docs/source/snugglygoblin.png
index f325ae4b..f325ae4b 100644
--- a/docs/snugglygoblin.png
+++ b/docs/source/snugglygoblin.png
Binary files differ
diff --git a/docs/theminghowto.rst b/docs/source/theminghowto.rst
index 7b40685f..7b40685f 100644
--- a/docs/theminghowto.rst
+++ b/docs/source/theminghowto.rst
diff --git a/docs/vision.rst b/docs/source/vision.rst
index fad248df..fad248df 100644
--- a/docs/vision.rst
+++ b/docs/source/vision.rst