Markmin looks pretty sweet, tiny and fast! http://www.web2py.com/examples/static/markmin.html
C. On Jul 14, 12:36 pm, mdipierro <[email protected]> wrote: > We had an attempt to use rest and sphinx but now that despitce help > form many people we never managed to make it work decently because of > third party dependencies. I'd rather use something that only requires > web2py to be parsed. MARKMIN was designed in such a way to allow this > > def example(): > """ > # title [[example]] > this is a doc string and the following is a doctest > > `` > >>> print 'hello world' > hello world > ``:code_python > > Read more: [click here #example]] > """ > > Notice a docstring that contains a doctest which is also a markmin > code that specifies the language for highlight, an [[anchor]] and a > [[link the #anchor]]. And no weird :: like in rest. > > On 14 Lug, 10:44, weheh <[email protected]> wrote:> Then, let it be > epydocs (thanks ra3don). Let's get concensus on a good > > template for a man-page docstring and get on with it! > > > I'm going to suggest that major headings include: > > > Name of command > > Synopsys > > Description > > Parameters and their meanings > > Return values > > Examples > > Links (to external documentation) > > Comments > > > I just now looked at the php documentation and it covers all the > > above. Indeed, it looks really useful and is well organized.
