Skip to content

Commit

Permalink
doc: trim module API documentation to an overview table of content
Browse files Browse the repository at this point in the history
Previously, the setup was confusing. Every symbol imported to module
level was documented directly. If a ToC was added, sphinx would fail
due to documentation generated twice for the same symbol.

The new setup **requires** a dedicated autosummary selection of
documented content.

I think this is better. Often modules provide a lot of stuff, and
direct documentation rendering on a single page is overwhelming.
The explicit selection also allows for items to be excluded
that are only there for technical or historical reasons. This allows for
an overall more accessible documentation.
  • Loading branch information
mih committed Oct 8, 2024
1 parent 865665a commit 704aeed
Showing 1 changed file with 0 additions and 3 deletions.
3 changes: 0 additions & 3 deletions docs/source/_templates/autosummary/module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,4 @@
{{ underline }}

.. automodule:: {{ fullname }}
:members:
:undoc-members:
:show-inheritance:
{% endif %}

0 comments on commit 704aeed

Please sign in to comment.