Beyond that, epydoc is virtually unsupported now (having no activity for more than a year now). I've used it for quite a while, but it chokes on some perfectly valid Python. To accommodate it, you sometimes have to jump backwards through fiery hoops. =(
I don't know Sphinx, but it is THE python documentation future and it creates beautiful documentation too. My only complaint is that it's JS-based search can be very slow. -tim mdipierro wrote: > It was clear from me at pycon that Sphinx is considered the present > and future of python documentation. > > On Mar 31, 7:48 am, Grahack <christophegrag...@yahoo.fr> wrote: > >> Massimo, could you please detail why Epydoc is limited. I personaly >> use it with ReST formatting and find it OK, but am interested to see >> the lacks. >> I see an 'autodoc' extension for Sphinx. Is it the kind of thing you >> want to do? >> >> On Mar 31, 6:29 am, Yarko Tymciurak <yark...@gmail.com> wrote: >> >> >>> I've looked >>> athttp://sphinx.pocoo.org/ext/doctest.html?highlight=doctest#module-sph... >>> and the sphinx sources (to see how they are doing this).... >>> >>> And it looks like we should just start a branch (I don't see any way to >>> easily share a branch). >>> >>> Give me a day to think about how I want to manage this... >>> >>> On Mon, Mar 30, 2009 at 7:35 PM, Douglas Soares de Andrade < >>> >>> dsandr...@gmail.com> wrote: >>> >>>> Em Segunda-feira 30 Março 2009, às 19:49:03, Yarko Tymciurak escreveu: >>>> >>>>> Now that PyCon is (almost) over, I can take this on. >>>>> - Yarko >>>>> >>>> Hi Yarko, >>>> >>>> Count me in, how do you want to organize things ? >>>> >>>>> On Mon, Mar 30, 2009 at 4:06 PM, mdipierro <mdipie...@cs.depaul.edu> >>>>> >>>> wrote: >>>> >>>>>> I think we need to re-factor the docstrings in web2py using reST and >>>>>> Sphinx. >>>>>> >>>>>> Anybody good at it willing to take charge for this project? >>>>>> >>>>>> I think it should be a priority. For me this is more important than >>>>>> the WIKI since the current docstrings/epydocs are really limited. >>>>>> >>>>>> Massimo >>>>>> > > > -- Timothy Farrell <tfarr...@swgen.com> Computer Guy Statewide General Insurance Agency (www.swgen.com) --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "web2py Web Framework" group. To post to this group, send email to web2py@googlegroups.com To unsubscribe from this group, send email to web2py+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/web2py?hl=en -~----------~----~----~----~------~----~------~--~---
