heckyel/mediagoblin
0
0
Fork 0
Code Issues Pull Requests Releases Activity

Allow doc string extraction and use for pluginapi.

Browse Source 
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.
This commit is contained in:
Elrond
2013-01-26 00:12:18 +01:00
parent 3a8b18f85b
commit 92c597ca1c
3 changed files with 25 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/source/pluginwriter/api.rst Normal file
View File

@@ -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