Hi David,
You should use::
.. automodule:: main
:members:
I hope my EuroPython presentation slide would help you.
http://www.slideshare.net/shimizukawa/sphinx-autodoc-automated-api-documentation-europython-2015-in-bilbao
Regards,
--
Takayuki SHIMIZUKAWA
http://about.me/shimizukawa
On Thu, Jul 30, 2015 at 8:25 PM DavidA <[email protected]> wrote:
> Hi
>
> I am new to Sphinx. I want to use it to document my Python project.
> Working on Windows, I have installed Sphinx, including the Autodoc
> extension. I have run sphinx-quickstart to create a project.
>
> Now, supposing I have a Python script called main.py, what directives
> should I use to pull the docstrings out of main.py, and where should I put
> those directives?
>
> Best regards
>
> David
>
> --
> You received this message because you are subscribed to the Google Groups
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to [email protected].
> To post to this group, send email to [email protected].
> Visit this group at http://groups.google.com/group/sphinx-users.
> For more options, visit https://groups.google.com/d/optout.
>
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.
