← Back to team overview

gtg team mailing list archive

[Bug 526150] Re: Create a nice web documentation of GTG functions

 

For code documentation, the codebase already has PyDoctor support, just
do 'make apidocs' from the base directory.  I've been adding
documentation to the GTG functions and using the web docs on my local
(non-public) web server as reference.

Perhaps if we had those docs online, that could be considered a solution
to this bug report?  Is it possible to have 'make apidocs' cronned
hourly on our webserver?

-- 
Create a nice web documentation of GTG functions
https://bugs.launchpad.net/bugs/526150
You received this bug notification because you are a member of Gtg
contributors, which is subscribed to Getting Things GNOME!.

Status in Getting Things GNOME!: Confirmed

Bug description:
Several potential developers come by IRC or mail someone in the team, interested in helping out with gtg. 
However, we are not extremely easy to hack into for unexperienced developers: therefore, we are losing patches.

I think we should write a simple guide for that, and generate a web documentation of our functions (via http://docs.python.org/library/pydoc ? I'm not an expert on this matter).
That should make things seem more easy.





References