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.
This commit is contained in:
parent
3a8b18f85b
commit
92c597ca1c
@ -26,7 +26,7 @@ sys.path.insert(0, os.path.abspath(os.path.join('..', '..')))
|
|||||||
|
|
||||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
extensions = []
|
extensions = ['sphinx.ext.autodoc']
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = ['source/_templates']
|
templates_path = ['source/_templates']
|
||||||
|
@ -70,6 +70,7 @@ This guide covers writing new GNU MediaGoblin plugins.
|
|||||||
|
|
||||||
pluginwriter/foreward
|
pluginwriter/foreward
|
||||||
pluginwriter/quickstart
|
pluginwriter/quickstart
|
||||||
|
pluginwriter/api
|
||||||
|
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
|
23
docs/source/pluginwriter/api.rst
Normal file
23
docs/source/pluginwriter/api.rst
Normal 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
|
Loading…
x
Reference in New Issue
Block a user