Automatically create a toctree for autodoc classes in Sphinx

Question

I'm looking to increase the documentation in one of my libraries. I've been using sphinx to help build the documentation and recently started exploring the autodoc extension.

It seems like in most professional documentation, each class documentation page has a list of all the documented methods with links at the top. Or, in other words, a toctree at the top with hyperlinks to each of the more in depth method documentation.

Is there a way to automatically create this toctree for each of the classes being documented with autodoc?

This might be of interest: stackoverflow.com/q/14606348/407651 — mzjn
– mzjn, Commented Jan 2, 2016 at 8:15
@mzjn, that is of interest and I have it partially implemented. However, I am still not able to get a toctree at the top of the class documentation within the stub. — Ben Hoff
– Ben Hoff, Commented Mar 6, 2016 at 2:27
Oh, nvm I was confused. I got it to work! If you want to post an answer, I'll accept it. Otherwise I'll post one up for posterity. — Ben Hoff
– Ben Hoff, Commented Mar 6, 2016 at 20:30

Ben Hoff · Accepted Answer · 2018-10-25 18:49:01Z

18

In your conf.py file for sphinx add

extensions = ['sphinx.ext.autosummary',]
# NOTE: Don't overwrite your old extension list! Just add to it!

autodoc_default_flags = ['members']
autosummary_generate = True

I put the toctree in my index.rst, and it looks like this:

.. autosummary::
     :toctree: stubs

     Class1
     Class2
     Class3

See this example for the conf.py settings

and this example for an example of the toctree.

Hope that helps!

edited Oct 25, 2018 at 18:49

answered Nov 25, 2016 at 16:54

Ben Hoff

1,1181 gold badge12 silver badges24 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Automatically create a toctree for autodoc classes in Sphinx

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related