On Thu, Sep 27, 2018 at 4:09 PM c.buhtz wrote:
>
> Dear Matthias,
>
> I fixed the module name and added a autodoc command to the rst file -
> see in upstream.
>
> The result is the same. The "module index" in the docs is empty.
OK, we are getting closer.
The first little thing is a missing space. You wrote:
.. automodule::buhtzsphinx
but it should be:
.. automodule:: buhtzsphinx
But it still doesn't work ...
The next problem is that what you wrote into __main__.py should
actually go into __init__.py.
If you do that, you'll get something! Congratulations!
But the docs for myclass.MyClass are still missing ...
It turns out that I was wrong in thinking that "automodule" would
automatically include submodules. It looks like it doesn't. You'll
have to specify each module separately, e.g.:
.. automodule:: buhtzsphinx.myclass
:members:
This should finally show the docs of MyClass!
cheers,
Matthias
--
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 https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.
