8 Commits

Author SHA1 Message Date
Christopher Allan Webber
36748921c2 adding callable_runone and callable_runall to the docs 2013-04-11 16:57:11 -05:00
Elrond
cf41e7d744 Improve formatting for hook template docs. 2013-01-31 20:58:19 +01:00
Christopher Allan Webber
75621003af Added register_template_hooks and get_hook_templates to the plugin api
auto module documentation.
2013-01-30 13:27:40 -06:00
Elrond
ae9f0aec38 Docs: Add a database guide to the plugin docs.
Plugin writers will often need to create new tables. So
give them some hints, what they need to do and where they
might find more info.
2013-01-26 19:38:52 +01:00
Elrond
92c597ca1c 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.
2013-01-26 00:15:57 +01:00
Will Kahn-Greene
05e007c1db Rework plugin infrastructure to nix side-effects
This reworks the plugin infrastructure so as to remove module-loading
side-effects which were making things a pain in the ass to test.

With the new system, there's no auto-registering meta class. Instead
plugins do whatever they want and then specify a hooks dict that maps
hook names to callables for the things they're tying into. The most
common one (and the only one we've implemented so far) is "setup".

This also simplifies the sampleplugin a little by moving the code
to __init__.py.
2012-07-17 21:02:12 -04:00
Will Kahn-Greene
469f10e4a7 Add plugin writer's quickstart guide 2012-05-23 21:16:18 -04:00
Will Kahn-Greene
2530ef7a1f Split docs into siteadmin and pluginwriter guides
* create initial bits for plugin writer's guide
* move siteadmin stuff to site administrator's guide
* rework index.rst to support multiple guides
* tweak some text
* move files into subdirectories

I verified that this still works with html and texinfo build targets.
There's still a lot of work to do, but this is a good start.
2012-05-23 20:21:03 -04:00