`autosummary` does not list all functions in a module
Closed this issue · 0 comments
The main function ppt_distinguishability is listed in the documentation but the other two public functions are not listed in the docs.
We want to list all the functions in a module.
Non-local games does appear to do this using automodule but it is recommended to use autosummary. The issue with autosummary is that it does not list all functions in a module.
https://github.com/vprusso/toqito/blob/master/docs/nonlocal_games.rst#nonlocal-games
https://stackoverflow.com/a/53101990/10241324
Using recursive in b443ca7 did not work for autosummary. https://stackoverflow.com/a/62613202/10241324
One option is to use sphinx-apidoc instead. https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html#sphinx-apidoc
Another option is to continue using autosummary and dig deep into what could work for our purposes.
To close this issue, make one style consistent across all rst files used for autosummary/ automodule.