Fix failing to build docs
authorChristopher Allan Webber <cwebber@dustycloud.org>
Wed, 28 Aug 2013 16:11:41 +0000 (11:11 -0500)
committerChristopher Allan Webber <cwebber@dustycloud.org>
Wed, 28 Aug 2013 16:11:41 +0000 (11:11 -0500)
docs/Makefile
docs/source/index.rst
docs/source/siteadmin/relnotes.rst
mediagoblin/tools/staticdirect.py

index 4461893fa0559e4f97493df335cec4d22447dde4..0b97bf7c20f2353cd5a8d2a856d312594d94a727 100644 (file)
@@ -2,7 +2,7 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    = -W
+SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = build
index 777c4d2635198ef79647f57f7d18df032328c124..e7fda4ad599e8acf046393a258721207eaef6438 100644 (file)
@@ -56,7 +56,6 @@ Part 2: Core plugin documentation
 
    plugindocs/flatpagesfile
    plugindocs/sampleplugin
-   plugindocs/oauth
    plugindocs/trim_whitespace
    plugindocs/raven
    plugindocs/basic_auth
index 40e84766759a15d6a125651905c12ea21b362d43..e7bf003a087777e168f557becaa68946e2872d51 100644 (file)
@@ -141,6 +141,7 @@ please note the following:
 
 
 **New features**
+
 * PDF media type!
 * Improved plugin system.  More flexible, better documented, with a
   new plugin authoring section of the docs.
index ef8b20d083197792e22a67b51b2350ed75a55818..8381b8b6874b81ec475dfa5399bd05a1aab18868 100644 (file)
@@ -35,7 +35,8 @@ class StaticDirect(object):
     staticdirect to.  In general, you should supply a None domain, as
     that's the "default" domain.
 
-    Things work like this:
+    Things work like this::
+
       >>> staticdirect = StaticDirect(
       ...     {None: "/static/",
       ...      "theme": "http://example.org/themestatic/"})
@@ -69,17 +70,18 @@ class PluginStatic(object):
 
     This has two mandatory attributes that you must pass in on class
     init:
-     - name: this name will be both used for lookup in "urlgen" for
-       your plugin's static resources and for the subdirectory that
-       it'll be "mounted" to for serving via your web browser.  It
-       *MUST* be unique.  If writing a plugin bundled with MediaGoblin
-       please use the pattern 'coreplugin__foo' where 'foo' is your
-       plugin name.  All external plugins should use their modulename,
-       so if your plugin is 'mg_bettertags' you should also call this
-       name 'mg_bettertags'.
-     - file_path: the directory your plugin's static resources are
-       located in.  It's recommended that you use
-       pkg_resources.resource_filename() for this.
+
+    - *name:* this name will be both used for lookup in "urlgen" for
+      your plugin's static resources and for the subdirectory that
+      it'll be "mounted" to for serving via your web browser.  It
+      *MUST* be unique.  If writing a plugin bundled with MediaGoblin
+      please use the pattern 'coreplugin__foo' where 'foo' is your
+      plugin name.  All external plugins should use their modulename,
+      so if your plugin is 'mg_bettertags' you should also call this
+      name 'mg_bettertags'.
+    - *file_path:* the directory your plugin's static resources are
+      located in.  It's recommended that you use
+      pkg_resources.resource_filename() for this.
 
     An example of using this::