We need some "Part" for developers. Currently, it's named
"Part 4: Developer's Zone". But we should come up with a
better name soon.
Moved the codebase docs in there for starters.
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.
Commit 8d19cb2445e2aa1f53431da26d866bf9b5e25872 accidentally included
my docs/source/build directory. Removing it again. Thanks to Elrond for
noticing.
Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
Rather than mentioning a hypothetical module restrictfive, we use the
existing plugin mediagoblin-licenses that people can install. Also,
mention that plugin in the release notes.
Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
We were not actually using the routes package anymore, but it was
still mentioned in the documention. Adapt the plugin documentation to
actually represent reality, although I don't like the API design.
(but this is for another day)
Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
I did a pass on language and more reST formatting. This is a little
cleaner, though there are a couple of parts that feel like they could
use some work.
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.
- Added chapter about media type negotiation.
- Added instructions on how to install dependencies for the audio media
type.
- Moved part about how to enable media types in your config to a single
place at the top of the document named "Enable Media Types".
- Renamed the "Enable Media Types" page to "Media Types".
Adds a summary and a link to the wiki for contributors to the front page.
The "what is mediagoblin" section in the about chapter talkd about what
it was, but it was buried--this slightly unburies it.
* 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.
