I am using sphinx for documenting, my python extension.
.. automodule:: ecflow
:members:
:undoc-members:
:show-inheritance:
I can the reference individual classes like:
- :py:class:`ecflow.DState`
My directory structure is:
/ecflow/__init__.py
ecflow.so
I have modified my conf.py to pick the right dir:
sys.path.insert(0,os.getcwd() + "/../../Pyext/ecflow")
extensions = ['sphinx.ext.viewcode' , 'sphinx.ext.autodoc' ]
This all works like a charm.
However I also want to document functions/classes described
in the __init__.py. but cant find any way to do this.
First is it possible to use the automodule function to document
doc strings in a __init.py__ ?
Any help/insight would be appreciated.
Best regards,
Ta,
Avi
--
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@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.
