Sphinx is what is used for Python docs - additionally, Bruce Eckel is working on a Python3 book (for publication) using Sphinx; I've worked out geometry controls, generating the LaTeX / PDF, etc. for that book, so I'm pretty confident Sphinx / ReST at this point is a good, serious choice. Like I said, there's other tools - this just seems to have more momentum for documenting Python.
BTW - the reference I use mostly is: http://docutils.sourceforge.net/docs/user/rst/quickref.html but the Sphinx <http://sphinx.pocoo.org/rest.html>ReST reference is good to (Sphinx dis-allows some ReST). On Sat, Dec 13, 2008 at 3:50 PM, pedro <pedro...@gmail.com> wrote: > > Those arguments are valid to pretty much any markup format out there: > markdown, Textile, wikimarkup, bbcode, docbook, latex html, etc. > Ok, the fact that is known to many python programmers is a definitive > plus. > > I find an indent as a way of defining a block sort of unpractical... > if we're talking about markup languages. But I guess it's a matter of > getting used to it. > Anyway, thank you for adding the example. > > Somehow i missed it earlier today > http://docutils.sourceforge.net/docs/user/rst/quickstart.html > > > On 13 Dec, 21:50, "Yarko Tymciurak" <yark...@gmail.com> wrote: > > also it is the basis for Python documentation <http://docs.python.org/> > - > > that is, Sphinx <http://sphinx.pocoo.org/contents.html> uses ReST as > it's > > basis. > > By using ReST,. we provide an underlying markup that can be used to > create a > > "book" (online or otherwise), and we build on existing Python Tools and > > knowledge. > > > > While at one level ReST may not be the easiest, it is easy enough and > > provides a good path to using existing tools. > > > > On Sat, Dec 13, 2008 at 2:44 PM, DenesL <denes1...@yahoo.ca> wrote: > > > > > It is possible to post code fragments, use a double colon :: > > > See the wiki for an example. > > > > > I also find it hard at times to use ReST (or markdown) being new to > > > it, but the advantage I see in using ReST is that it can create > > > printable documentation, even in PDF. > > > > > On Dec 13, 7:39 am, pedro <pedro...@gmail.com> wrote: > > > > I've registered and I started playing around and submitting some > > > > content. > > > > Should this take off we need to discuss some important things. > > > > The first and most important for the moment is the markup. I am not > > > > sure Rest or markdown are suited for this job. Personally I like > > > > markdown, but AFAIK there is no way to post chunks of code. > > > > I don't know which parsers are out there available in python but > maybe > > > > yet another alternative should be considered or maybe an existent > wiki > > > > engine could simply be used. > > > --~--~---------~--~----~------------~-------~--~----~ 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 -~----------~----~----~----~------~----~------~--~---
