Did you see autosummary <http://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html> then?
Result example: http://atelier.lino-framework.org/api/index.html Source code: https://raw.githubusercontent.com/lino-framework/atelier/master/docs/api/index.rst conf.py : https://github.com/lino-framework/atelier/blob/master/docs/conf.py Luc On 02.10.2018 00:30, [email protected] wrote: > I also found the autoapi extension. > But even this is far away from being "auto" because I have to write all > members into the __all__ variable in each module. > > The point for me in "auto" is I don'T want to think about if I have to > add a new created member to an __all__ variable or write it into an > rst-file or whatever. > > Isn't there nothing out there doing this automatic? > It is just py-file parsing and then rearrange the data to a html (or > whatever) file. > > I don't see how sphinx and Co can improve my workflow and save my time > resources. > > I am sure there is an advantage of Sphinx because the whole world is > using it. But I am not seeing it. So please help the blind. ;) > > On 2018-09-28 21:40 Matthias Geier <[email protected]> wrote: >> 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.
