On Saturday 03 October 2009 18:13:51 Oben wrote:
> But seriously, if reST and Sphinx are supposed to be the standard for
> Python documentation, isn't backwards to force shifting API
> documentation out of the docstrings? AFAIK the official Python
> documentation is written mostly outside the source code and I see the
> benefits of this approach as it avoids API generator look-a-like
> documentation. OTH I would guess many projects in the Python world are
> happy with simple API generation, consider the JavaDoc workflow as an
> example. Well, there are tools like epydoc but I would prefer to
> follow the "official" Python documentation conventions and tools. I'm
> quite surprised Sphinx does not spend much attention to
> straightforward API doc generation.
Why not use the doc generator to create sphinx's source files? The best of
both worlds ;-)
--
("\''/").__..-''"`-. . Roberto Alsina
`9_ 9 ) `-. ( ).`-._.`) KDE Developer (MFCH)
(_Y_.)' ._ ) `._`. " -.-' http://lateral.netmanagers.com.ar
_..`-'_..-_/ /-'_.' The 6,855th most popular site of Slovenia
(l)-'' ((i).' ((!.' according to alexa.com (27/5/2007)
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"sphinx-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/sphinx-dev?hl=en
-~----------~----~----~----~------~----~------~--~---
