For documenting the code itself, I have some experience using Sphinx (http://sphinx.pocoo.org), the same tool that is used for the actual Python docs.
You do need to maintain a separate tree with some .rst files, but it does a very good job of pulling docstrings out of code, classes and functions and displaying them. Maybe this is a good option to help new developers explore & understand the GTG source. -- 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. _______________________________________________ Mailing list: https://launchpad.net/~gtg Post to : [email protected] Unsubscribe : https://launchpad.net/~gtg More help : https://help.launchpad.net/ListHelp
