Hi Thomi, I got the result that you expected with bot Sphinx-1.1.3 and 1.2b1. Did you solve your problem yet?
Regards, -- Takayuki SHIMIZUKAWA http://about.me/shimizukawa 2013/4/8 Thomi Richards <tho...@gmail.com>: > Hi everyone, > > > I'm using sphinx to document a python project of mine. I've run into a > problem with the automodule directive - it seems to ignore module-level > docstrings. For example: > > in module.py: > > <code> > > """ > My Module > ######### > > General introductory text to this module - links to classes & functions > defined in the module go here. > > """ > > def a_function(): > """some docstring for a_function.""" > > > class Foo(object): > """Some docstring for Foo.""" > > </code> > > > in my sphinx documentation files, I have: > > <code> > .. automodule:: module > :members: > </code> > > > What I expect to see in the output is something similar to: > <output> > <heading>My module</heading> > > General introductory text to this module - links to classes & functions > defined in the module go here. > > documentation for 'a_function' > > documentation for 'Foo' > </output> > > > Instead, I just get the documentation for the functions & classes defined in > that module. > > > Is there any way to get the automodule directive to use module-level > docstrings as an introductory text to the module documentation? > > > Thanks, > > -- > 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 sphinx-users+unsubscr...@googlegroups.com. > To post to this group, send email to sphinx-users@googlegroups.com. > Visit this group at http://groups.google.com/group/sphinx-users?hl=en. > For more options, visit https://groups.google.com/groups/opt_out. > > -- 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 sphinx-users+unsubscr...@googlegroups.com. To post to this group, send email to sphinx-users@googlegroups.com. Visit this group at http://groups.google.com/group/sphinx-users?hl=en. For more options, visit https://groups.google.com/groups/opt_out.
