On Thu, Oct 21, 2010 at 10:09 AM, Maarch <monbast...@yahoo.fr> wrote:
> I'm trying to use Sphinx to provide a documentation site for my
> company. We  develop an open source software and our source code it's
> not accessible because not well documented.
> It's mentioned that we can generate autodoc from Sphinx but I can't
> find what should I configure to add this extension.
> Can I have help please?

I can't tell from your query, so I have to ask: have you read the
documentation? Sphinx, being a tool for documentation, tends to have
great documentation, and the docs for autodoc don't disappoint:
http://sphinx.pocoo.org/ext/autodoc.html

Basically you just make sure the code you want to extract docstrings
from is on PYTHONPATH, and then do something like::

    .. autoclass:: mymodule.MyClass

In your docs.

Jacob

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-...@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Reply via email to