Would it be possible to add the in-code documentation to the sphinx
module documentation rather than use epydoc for this stuff?

I'm not opposed to doing epydoc, but I would like to have all the API
docs available in sphinx where possible -- even if that's in addition
to some external epydoc docs.

Theoretically it should be as easy as adding module doc to those here:

http://svn.turbogears.org/docs/2.0/docs/modules/thirdparty/

The tg.flash docs for example are generated from a file like this:

:mod:`tg.flash` -- Flash
========================================

.. automodule:: tg.flash
  :members:

http://svn.turbogears.org/docs/2.0/docs/modules/tgflash.rst



On Tue, Oct 21, 2008 at 9:08 AM, Gustavo Narea <[EMAIL PROTECTED]> wrote:
>
> Hello,
>
> I'm making tgext.authorization with exhaustive in-code documentation (powered
> by Epydoc), so that those who want to extend it (which should be very common)
> don't have to dive into the source code to learn how some classes must be
> extended.
>
> So, I wonder whether the generated API documentation may be hosted somewhere
> at turbogears.org?
>
> Cheers.
> --
> Gustavo Narea.
> http://gustavonarea.net/
>
> Get rid of unethical constraints! Switch to Freedomware:
> http://softwareliberty.com/
>
>
> >
>



-- 
Mark Ramm-Christensen
email: mark at compoundthinking dot com
blog: www.compoundthinking.com/blog

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"TurboGears Docs" 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/turbogears-docs?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to