On Jan 27, 9:09 am, Christopher Lee <[email protected]> wrote: > Could this easily incorporate our existing documentation, which is in > latex format? (I just followed the same system for docs that Python > uses; I just took the Python docs templates and replaced it with my
Yes it is very easy to incorporate the existing docs. The new markup is super simple, I have reformatted the devguide from latex and it looks like this: http://atlas.bx.psu.edu/pygr/_sources/guides/devguide.txt and renders like this: http://atlas.bx.psu.edu/pygr/guides/devguide.html I've done this manually, it is a fairly straightforward transformation, but I will need help doing them all, because there are quite a few such documents. Here is a chance to contribute for everyone who wants to do something easy and important. > One obvious benefit: it would immediately make us improve many of our > docstrings... ;-) You could argue that unless you put in place such a > system, there's a tendency to not update or refine the docstrings as > much as you should, because you have the feeling that no one's reading > them. Right on. 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 -~----------~----~----~----~------~----~------~--~---
