On Jan 27, 8:07 am, Christopher Lee <[email protected]> wrote: > In our next developer conference call, we should probably discuss how > your site should change our current approach(es) to documentation, > which at present are scattered all over the map.
Yes, I plan to port all the documentation and scattered tidbits over to this format. Everything is/will be in the main repository tracked via git. Besides html one can format these docs as latex/pdf or plain text. And a reminder (that never ceases to amaze me) most of the code samples are actually executed and verified that they produce the presented outcome. There is a hidden section in each doc that allows us to do some scaffolding for code snippets that need some initialization - without complicating the main documentation. One outstanding issue is how to format the pygr API that is automatically extracted from the sources: http://atlas.bx.psu.edu/pygr/epydoc/index.html We can use Sphinx for that as well, but over the years I have grown fond of epydoc. It directly generates javadoc like files from the code with no other step involved, I really like the frame based navigation here, usually frames suck but in this case allows one to jump to various documentation sections with ease. Istvan --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "pygr-dev" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/pygr-dev?hl=en -~----------~----~----~----~------~----~------~--~---
