diff options
| author | Elrond <elrond+mediagoblin.org@samba-tng.org> | 2013-01-26 00:12:18 +0100 |
|---|---|---|
| committer | Elrond <elrond+mediagoblin.org@samba-tng.org> | 2013-01-26 00:15:57 +0100 |
| commit | 92c597ca1cd0d93df7246eb2f81f84bcb08673ce (patch) | |
| tree | 40bdef54f63424235397724046e2a4df0a460241 /docs/source/pluginwriter | |
| parent | 3a8b18f85b9affca46a433607d7d9ae723380b94 (diff) | |
| download | mediagoblin-92c597ca1cd0d93df7246eb2f81f84bcb08673ce.tar.lz mediagoblin-92c597ca1cd0d93df7246eb2f81f84bcb08673ce.tar.xz mediagoblin-92c597ca1cd0d93df7246eb2f81f84bcb08673ce.zip | |
Allow doc string extraction and use for pluginapi.
Allow us to extract docstrings from our sources using the
sphinx.ext.autodoc module.
First use: Extract some of the docs for the pluginapi and
provide it in a new "Plugin API" section.
Diffstat (limited to 'docs/source/pluginwriter')
| -rw-r--r-- | docs/source/pluginwriter/api.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/source/pluginwriter/api.rst b/docs/source/pluginwriter/api.rst new file mode 100644 index 00000000..206c8b0b --- /dev/null +++ b/docs/source/pluginwriter/api.rst @@ -0,0 +1,23 @@ +.. MediaGoblin Documentation + + Written in 2013 by MediaGoblin contributors + + To the extent possible under law, the author(s) have dedicated all + copyright and related and neighboring rights to this software to + the public domain worldwide. This software is distributed without + any warranty. + + You should have received a copy of the CC0 Public Domain + Dedication along with this software. If not, see + <http://creativecommons.org/publicdomain/zero/1.0/>. + + +========== +Plugin API +========== + +:mod:`pluginapi` Module +----------------------- + +.. automodule:: mediagoblin.tools.pluginapi + :members: get_config, register_routes, register_template_path |