aboutsummaryrefslogtreecommitdiffstats
path: root/mediagoblin/tools/staticdirect.py
diff options
context:
space:
mode:
authortilly-Q <nattilypigeonfowl@gmail.com>2013-09-12 18:58:04 -0400
committertilly-Q <nattilypigeonfowl@gmail.com>2013-09-12 18:58:04 -0400
commit045fe0ee9d43aa825de6fbf14fe8fd48953d4eff (patch)
treee0743c13e20845a613ba8e4064cb1e0f10f54025 /mediagoblin/tools/staticdirect.py
parenta02831687a6026b2baa0f971ecb3e594c3f415e2 (diff)
parent66cafc3b74d476710013efb46341b989028f3057 (diff)
downloadmediagoblin-045fe0ee9d43aa825de6fbf14fe8fd48953d4eff.tar.lz
mediagoblin-045fe0ee9d43aa825de6fbf14fe8fd48953d4eff.tar.xz
mediagoblin-045fe0ee9d43aa825de6fbf14fe8fd48953d4eff.zip
Merge branch 'master' into OPW-Moderation-Update
Conflicts: mediagoblin/db/migrations.py
Diffstat (limited to 'mediagoblin/tools/staticdirect.py')
-rw-r--r--mediagoblin/tools/staticdirect.py26
1 files changed, 14 insertions, 12 deletions
diff --git a/mediagoblin/tools/staticdirect.py b/mediagoblin/tools/staticdirect.py
index ef8b20d0..8381b8b6 100644
--- a/mediagoblin/tools/staticdirect.py
+++ b/mediagoblin/tools/staticdirect.py
@@ -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::