On 06/16/2010 10:49 PM, Rob Crittenden wrote:
Adam Young wrote:
Is there any documentation on how to write plugins, or extend existing
plugins?

Pavel annotated a sample plugin:

https://fedorahosted.org/freeipa/browser/doc/examples/examples.py

ipalib/__init__.py has a fair amount of documentation in it including a section called:

Tutorial for Plugin Authors

One of the things Jason was very good at doing was including documentation. It's always inline in the source code which is common Python practice and is in rst (reStructuredText) format. This is so epydoc (and other tools) can extract it and format it. Thus you might find it easier to read the generated doc rather than the inline, however rst is designed to be readable on it's own, plus you get to see the actual source next to it. But on the other hand the generated doc does have hyperlinks which can be a real help.

HTH,

John


--
John Dennis <[email protected]>

Looking to carve out IT costs?
www.redhat.com/carveoutcosts/

_______________________________________________
Freeipa-devel mailing list
[email protected]
https://www.redhat.com/mailman/listinfo/freeipa-devel

Reply via email to