Fix failing to build docs

This commit is contained in:
Christopher Allan Webber 2013-08-28 11:11:41 -05:00
parent 9dfca6b3ce
commit b33feb18a7
4 changed files with 16 additions and 14 deletions

View File

@ -2,7 +2,7 @@
# #
# You can set these variables from the command line. # You can set these variables from the command line.
SPHINXOPTS = -W SPHINXOPTS =
SPHINXBUILD = sphinx-build SPHINXBUILD = sphinx-build
PAPER = PAPER =
BUILDDIR = build BUILDDIR = build

View File

@ -56,7 +56,6 @@ Part 2: Core plugin documentation
plugindocs/flatpagesfile plugindocs/flatpagesfile
plugindocs/sampleplugin plugindocs/sampleplugin
plugindocs/oauth
plugindocs/trim_whitespace plugindocs/trim_whitespace
plugindocs/raven plugindocs/raven
plugindocs/basic_auth plugindocs/basic_auth

View File

@ -141,6 +141,7 @@ please note the following:
**New features** **New features**
* PDF media type! * PDF media type!
* Improved plugin system. More flexible, better documented, with a * Improved plugin system. More flexible, better documented, with a
new plugin authoring section of the docs. new plugin authoring section of the docs.

View File

@ -35,7 +35,8 @@ class StaticDirect(object):
staticdirect to. In general, you should supply a None domain, as staticdirect to. In general, you should supply a None domain, as
that's the "default" domain. that's the "default" domain.
Things work like this: Things work like this::
>>> staticdirect = StaticDirect( >>> staticdirect = StaticDirect(
... {None: "/static/", ... {None: "/static/",
... "theme": "http://example.org/themestatic/"}) ... "theme": "http://example.org/themestatic/"})
@ -69,7 +70,8 @@ class PluginStatic(object):
This has two mandatory attributes that you must pass in on class This has two mandatory attributes that you must pass in on class
init: init:
- name: this name will be both used for lookup in "urlgen" for
- *name:* this name will be both used for lookup in "urlgen" for
your plugin's static resources and for the subdirectory that your plugin's static resources and for the subdirectory that
it'll be "mounted" to for serving via your web browser. It it'll be "mounted" to for serving via your web browser. It
*MUST* be unique. If writing a plugin bundled with MediaGoblin *MUST* be unique. If writing a plugin bundled with MediaGoblin
@ -77,7 +79,7 @@ class PluginStatic(object):
plugin name. All external plugins should use their modulename, plugin name. All external plugins should use their modulename,
so if your plugin is 'mg_bettertags' you should also call this so if your plugin is 'mg_bettertags' you should also call this
name 'mg_bettertags'. name 'mg_bettertags'.
- file_path: the directory your plugin's static resources are - *file_path:* the directory your plugin's static resources are
located in. It's recommended that you use located in. It's recommended that you use
pkg_resources.resource_filename() for this. pkg_resources.resource_filename() for this.