33 Commits

Author SHA1 Message Date
Rodney Ewing
fb900ef27b Merge branch 'auth_docs'
Conflicts:
	docs/source/index.rst
2013-08-16 10:24:41 -07:00
Christopher Allan Webber
2d0028e932 Documenting the media_manager fetching hook
This commit sponsored by Christian Corrodi.  Thank you!
2013-07-12 17:13:48 -05:00
Rodney Ewing
91bee92e8e documenting the new media_type plugins and available hooks 2013-07-12 14:35:43 -07:00
Rodney Ewing
d194770dd2 added docs explaining the authentication hooks 2013-07-10 13:29:58 -07:00
Christopher Allan Webber
7fa4e19fc4 Add a bit more docs to plugin configuration
This commit sponsored by Michael Rauch.  Thank you!
2013-06-25 13:25:25 -05:00
Christopher Allan Webber
25aad338d4 Added some test-writing docs for plugins, but not sure if they're good. ;)
This commit sponsored by Joe Lee.  Thank you!
2013-06-07 11:45:07 -05:00
Christopher Allan Webber
ea49f37821 Explained more clearly why it's okay for interface classes to be keys.
This commit sponsored by Nick Glynn.  Thank you!
2013-05-29 18:10:09 -05:00
Christopher Allan Webber
9d881aeeb4 Provide a tip on how to do interfaces via our plugin API.
Uses a frogputer science approach to frobbing as an example (which is
total nonsense, but fun).

This commit sponsored by Ryan Kelln.  Thank you!
2013-05-29 17:21:15 -05:00
Christopher Allan Webber
4001909574 Actually use the right underlining for the wtforms hooks section 2013-05-29 16:12:24 -05:00
Christopher Allan Webber
baf2c1c96e Additional hook tips! Documentation on how to modify a wtforms form.
This commit sponsored by Gian-Maria Daffré.  Thank you!
2013-05-29 15:57:58 -05:00
Christopher Allan Webber
8ae5d20f19 Where do you find hooks? How do you add them? An explaination!
This commit about talking to community members sponsored by
community member Aeva Palecek.  Thanks!
2013-05-29 15:35:37 -05:00
Christopher Allan Webber
b21220e931 Actually link to the release notes when we say "see the release notes".
This commit sponsored by Brian Kemp.  Thank you!
2013-05-29 14:13:12 -05:00
Christopher Allan Webber
d861ffc9ad Link to the plugin api stuff and the database plugin sections from the quickstart.
This commit sponsored by Nathan Stephenson.  Thank you!
2013-05-29 14:10:07 -05:00
Christopher Allan Webber
5de402781f Moving statcdirect automodule doc reference to autoclass per Elrond's suggestion.
Cleaner!
2013-05-23 15:56:33 -05:00
Christopher Allan Webber
24ede04415 Documentation changes to reflect new plugin assetlink stuff
- updated old theme assetlink section to reflect new location of
   ./bin/gmg assetlink and removed comment about the plugin command
   being temporary.
 - Added a new section to the standard config file on where to put the
   plugin_static section
 - Added release notes about said section

This commit sponsored by Thomas Webber.  Thanks, Dad!
2013-05-23 13:43:04 -05:00
Christopher Allan Webber
505b4b39b8 Document assetlink and staticdirect usage for plugins.
Still a bit to clean up around what the command to be run actually is,
since that will likely change.

This commit sponsored by David Decker.  Thank you!
2013-05-23 13:33:07 -05:00
Christopher Allan Webber
d6d2c771bd Start of ability to have plugins provide static resources!
Note I have not tested any of this yet ;)  But we're already on our way:
 - We've got docs
 - The hook is there

Lots to do still though.  But, progress! :)

This commit sponsored by Laura Arjona Reina.  Thanks larjona!
2013-05-23 13:33:07 -05:00
Christopher Allan Webber
38ebd05d1a Simple tyop, view->test... I was writing too many tests at the time :) 2013-05-15 11:29:43 -05:00
Christopher Allan Webber
0553976187 Hook->hooks since there's more than one of them :) 2013-05-15 11:10:25 -05:00
Christopher Allan Webber
1344c561a0 Adding global context hooks & fixing method names->symbolic view names in docs
This commit sponsored by Sheila Miguez.  Thanks Sheila!
2013-05-15 10:37:41 -05:00
Christopher Allan Webber
b312d2cd83 Added documentation on view specific hooks
This commit sponsored by Matthew Woodward.  Thank you!
2013-05-14 16:09:55 -05:00
Christopher Allan Webber
f65bf89836 Documenting plugin configuration
This commit sponsored by David Krupicz.  Thanks, David!
2013-05-08 11:03:09 -05:00
Elrond
b835e15319 Add warning about crypt/itsdangeroussecret.bin.
You should not leak that file, really.
2013-04-30 00:26:06 +02:00
Christopher Allan Webber
51d5d3aa20 changing the things to document in api.rst 2013-04-19 16:29:03 -05:00
Christopher Allan Webber
4d0191dcb8 A warning about the plugin API being unstable. 2013-04-19 13:22:03 -05:00
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