Thread: [Epydoc-devel] restructuredtext
Brought to you by:
edloper
From: Robin D. <ro...@al...> - 2004-04-27 15:29:16
|
What is the restructuredtext equivallent to L{object} ? -- Robin Dunn Software Craftsman http://wxPython.org Java give you jitters? Relax with wxPython! |
From: Edward L. <ed...@gr...> - 2004-04-27 16:45:31
|
Robin Dunn wrote: > What is the restructuredtext equivallent to L{object} ? It's `object` (i.e., backticks). -Edward |
From: Fred L. D. Jr. <fd...@ac...> - 2004-04-28 00:07:18
|
On Tuesday 27 April 2004 11:29 am, Robin Dunn wrote: > What is the restructuredtext equivallent to L{object} ? In Epydoc, the default reStructuredText "interpreted text role" is "identifier", so you can simply use `object` Epydoc seems to do quite well with turning that into a link to the documentation for object. Or at least that's how I've been doing it. ;-) -Fred -- Fred L. Drake, Jr. <fdrake at acm.org> PythonLabs at Zope Corporation |
From: Robin D. <ro...@al...> - 2004-04-28 01:48:34
|
Fred L. Drake, Jr. wrote: > On Tuesday 27 April 2004 11:29 am, Robin Dunn wrote: > > What is the restructuredtext equivallent to L{object} ? > > In Epydoc, the default reStructuredText "interpreted text role" is > "identifier", so you can simply use > > `object` > > Epydoc seems to do quite well with turning that into a link to the > documentation for object. > Yep, I've started using it this afternoon too. Now if only it didn't take epydoc twice as long to generate wxPython docs using reST than it does with epytext... -- Robin Dunn Software Craftsman http://wxPython.org Java give you jitters? Relax with wxPython! |
From: Fred L. D. Jr. <fd...@ac...> - 2004-04-28 21:50:44
|
On Tuesday 27 April 2004 09:48 pm, Robin Dunn wrote: > Yep, I've started using it this afternoon too. Now if only it didn't > take epydoc twice as long to generate wxPython docs using reST than it > does with epytext... I've done very little with epytext, so can't really compare the two performance-wise. Docutils definately takes a fairly heavy approach to processing; I know Ed's done some work that should improve that somewhat, but don't know if that's in the Docutils CVS yet. The use of DOM nodes in Docutils certainly causes it to squarely avoid the lightweight category. -Fred -- Fred L. Drake, Jr. <fdrake at acm.org> PythonLabs at Zope Corporation |
From: Robin D. <ro...@al...> - 2004-04-28 23:45:57
|
Fred L. Drake, Jr. wrote: > On Tuesday 27 April 2004 09:48 pm, Robin Dunn wrote: > > Yep, I've started using it this afternoon too. Now if only it didn't > > take epydoc twice as long to generate wxPython docs using reST than it > > does with epytext... > > I've done very little with epytext, so can't really compare the two > performance-wise. Docutils definately takes a fairly heavy approach to > processing; I know Ed's done some work that should improve that somewhat, but > don't know if that's in the Docutils CVS yet. The use of DOM nodes in > Docutils certainly causes it to squarely avoid the lightweight category. Yep, I fully expected that using reST would have an impact, but was a little surprised that it was this much. It's not really noticable when generating smaller file sets, but wxPython is big enough (almost 1000 html files generated, some quite large) that the time difference is probably measured in minutes. I havn't really measured it though, just gut feel at this point. It's not a big deal though. It's something that I can live with as once I get the basics worked out and figure out how I want to do various kinds of things I don't think I'll be rebuilding the docs more than a couple times a week, and will probably automate that. -- Robin Dunn Software Craftsman http://wxPython.org Java give you jitters? Relax with wxPython! |