heckyel/mediagoblin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix failing to build docs

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Makefile
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

1
docs/source/index.rst
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

1
docs/source/siteadmin/relnotes.rst
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.

26
mediagoblin/tools/staticdirect.py
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,17 +70,18 @@ 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
your plugin's static resources and for the subdirectory that - *name:* this name will be both used for lookup in "urlgen" for
it'll be "mounted" to for serving via your web browser. It your plugin's static resources and for the subdirectory that
*MUST* be unique. If writing a plugin bundled with MediaGoblin it'll be "mounted" to for serving via your web browser. It
please use the pattern 'coreplugin__foo' where 'foo' is your *MUST* be unique. If writing a plugin bundled with MediaGoblin
plugin name. All external plugins should use their modulename, please use the pattern 'coreplugin__foo' where 'foo' is your
so if your plugin is 'mg_bettertags' you should also call this plugin name. All external plugins should use their modulename,
name 'mg_bettertags'. so if your plugin is 'mg_bettertags' you should also call this
- file_path: the directory your plugin's static resources are name 'mg_bettertags'.
located in. It's recommended that you use - *file_path:* the directory your plugin's static resources are
pkg_resources.resource_filename() for this. located in. It's recommended that you use
pkg_resources.resource_filename() for this.
An example of using this:: An example of using this::