aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/pluginwriter
Commit message (Collapse)AuthorAgeFilesLines
* Add jgart to authors, mention old persona plugin in pluginwriter docs.Ben Sturmfels2021-04-231-0/+5
|
* Spell-check the entire documentation.Ben Sturmfels2016-09-185-15/+15
|
* Fix #822 - doc typo s/Plugin/PluginManager/Loic Dachary2016-07-251-1/+1
| | | | Signed-off-by: Loic Dachary <loic@dachary.org>
* doc: Note that plugin authors must NEVER modify tables they don't controlChristopher Allan Webber2016-03-261-0/+5
| | | | * docs/source/pluginwriter/database.rst: New paragraph.
* Update database docs for plugin authors for new alembic branching worldChristopher Allan Webber2016-03-261-27/+58
| | | | | | | | | | | Things have gotten both easier and more complex in the branching world view. Plugins branch off of main with their own migrations. Generating these has become a bit easier, but the steps for doing this are a bit wordy to explain. * docs/source/pluginwriter/database.rst: Update both the "Creating new Tables" and "Changing the Database Schema Later" sections accordingly.
* docs: Fixed typo - missing closing bracket in link in api.rstJim Campbell2015-03-291-1/+1
|
* docs: Fix bad link in api.rst. Fixes 1019Jim Campbell2015-03-291-1/+1
| | | | | Fixed link in the docs/source/pluginwriter/api.rst file. Resolves https://issues.mediagoblin.org/ticket/1019
* Add docs on collection_add_media hook.Elrond2014-08-191-0/+16
|
* Start for documenting core hooks.Elrond2014-08-191-0/+19
| | | | | This is basicly a start by Chris Webber, I'm just commiting it for him.
* Merge branch 'auth_docs'Rodney Ewing2013-08-161-0/+86
|\ | | | | | | | | Conflicts: docs/source/index.rst
| * added docs explaining the authentication hooksRodney Ewing2013-07-101-0/+86
| |
* | Documenting the media_manager fetching hookChristopher Allan Webber2013-07-121-0/+11
| | | | | | | | This commit sponsored by Christian Corrodi. Thank you!
* | documenting the new media_type plugins and available hooksRodney Ewing2013-07-121-0/+27
|/
* Add a bit more docs to plugin configurationChristopher Allan Webber2013-06-251-0/+26
| | | | This commit sponsored by Michael Rauch. Thank you!
* Added some test-writing docs for plugins, but not sure if they're good. ;)Christopher Allan Webber2013-06-071-0/+64
| | | | This commit sponsored by Joe Lee. Thank you!
* Explained more clearly why it's okay for interface classes to be keys.Christopher Allan Webber2013-05-291-1/+3
| | | | This commit sponsored by Nick Glynn. Thank you!
* Provide a tip on how to do interfaces via our plugin API.Christopher Allan Webber2013-05-291-0/+66
| | | | | | | Uses a frogputer science approach to frobbing as an example (which is total nonsense, but fun). This commit sponsored by Ryan Kelln. Thank you!
* Actually use the right underlining for the wtforms hooks sectionChristopher Allan Webber2013-05-291-1/+1
|
* Additional hook tips! Documentation on how to modify a wtforms form.Christopher Allan Webber2013-05-291-0/+33
| | | | This commit sponsored by Gian-Maria Daffré. Thank you!
* Where do you find hooks? How do you add them? An explaination!Christopher Allan Webber2013-05-291-0/+20
| | | | | This commit about talking to community members sponsored by community member Aeva Palecek. Thanks!
* Actually link to the release notes when we say "see the release notes".Christopher Allan Webber2013-05-291-1/+1
| | | | This commit sponsored by Brian Kemp. Thank you!
* Link to the plugin api stuff and the database plugin sections from the ↵Christopher Allan Webber2013-05-293-5/+11
| | | | | | quickstart. This commit sponsored by Nathan Stephenson. Thank you!
* Moving statcdirect automodule doc reference to autoclass per Elrond's ↵Christopher Allan Webber2013-05-231-2/+1
| | | | | | suggestion. Cleaner!
* Documentation changes to reflect new plugin assetlink stuffChristopher Allan Webber2013-05-231-3/+1
| | | | | | | | | | | - 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!
* Document assetlink and staticdirect usage for plugins.Christopher Allan Webber2013-05-231-0/+31
| | | | | | | 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!
* Start of ability to have plugins provide static resources!Christopher Allan Webber2013-05-231-0/+19
| | | | | | | | | | 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!
* Simple tyop, view->test... I was writing too many tests at the time :)Christopher Allan Webber2013-05-151-1/+1
|
* Hook->hooks since there's more than one of them :)Christopher Allan Webber2013-05-151-2/+2
|
* Adding global context hooks & fixing method names->symbolic view names in docsChristopher Allan Webber2013-05-151-3/+18
| | | | This commit sponsored by Sheila Miguez. Thanks Sheila!
* Added documentation on view specific hooksChristopher Allan Webber2013-05-141-0/+62
| | | | This commit sponsored by Matthew Woodward. Thank you!
* Documenting plugin configurationChristopher Allan Webber2013-05-081-0/+16
| | | | This commit sponsored by David Krupicz. Thanks, David!
* Add warning about crypt/itsdangeroussecret.bin.Elrond2013-04-301-1/+1
| | | | You should not leak that file, really.
* changing the things to document in api.rstChristopher Allan Webber2013-04-191-1/+1
|
* A warning about the plugin API being unstable.Christopher Allan Webber2013-04-191-0/+9
|
* adding callable_runone and callable_runall to the docsChristopher Allan Webber2013-04-111-1/+2
|
* Improve formatting for hook template docs.Elrond2013-01-311-1/+2
|
* Added register_template_hooks and get_hook_templates to the plugin apiChristopher Allan Webber2013-01-301-1/+1
| | | | auto module documentation.
* Docs: Add a database guide to the plugin docs.Elrond2013-01-261-0/+111
| | | | | | 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.
* Allow doc string extraction and use for pluginapi.Elrond2013-01-261-0/+23
| | | | | | | | 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.
* Rework plugin infrastructure to nix side-effectsWill Kahn-Greene2012-07-171-25/+22
| | | | | | | | | | | | | 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.
* Add plugin writer's quickstart guideWill Kahn-Greene2012-05-231-0/+189
|
* Split docs into siteadmin and pluginwriter guidesWill Kahn-Greene2012-05-231-0/+43
* 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.
generated by cgit v1.2.3 (git 2.25.1) at 2025-06-07 16:10:55 +0000