Autosummary lists functions but does not generate documentation pages about sphinx HOT 3 OPEN

A workaround is to copy the original template to _templates/autosummary/module.rst in your root docs directory and patch a single line in the functions section:

--- module.rst
+++ module.rst
@@ -18,6 +18,7 @@
    .. rubric:: {{ _('Functions') }}
 
    .. autosummary::
+      :toctree:
    {% for item in functions %}
       {{ item }}

As a downside, the custom template copies a lot of unchanged code, which does not get updates if you update sphinx.

Should I create a pull request? Is this the right place to fix, and are there other items like classes/methods where this also need to be applied?

from sphinx.

I see that other projects have full documentation of their functions, and I assume this is the wanted behavior. I also don't see other projects having extra stub generating scripts besides autosummary_generate = True.

@aeisenbarth could you link to a sample documentation project that does offer hyperlinked function documentation? (preferably one with an open source license, to make it easier to compare the configuration details)

from sphinx.

• Scanpy docs
• SpatialData docs

After further inspection, I am not sure whether there is some extra build process on top of what is specified in conf.py, when projects are hosted on readthedocs? (maybe sphinx-autoapi)

Others (xarray) explicitly specify every item.

I didn't observe projects that use autosummary to summarize unclickable items, but not document the items in some way. It seems to be desirable to document them. The question is maybe whether autosummary should do it by default or rather not.

from sphinx.