search

Eden-Kramer-Lab / spectral_connectivity

Frequency domain estimation and functional and directed connectivity analysis tools for electrophysiological data
GNU General Public License v3.0
121 stars 43 forks source link

[JOSS] Docs API section does not show function signatures #38

Closed sappelhoff closed 1 year ago

sappelhoff commented 1 year ago

See: https://spectral-connectivity.readthedocs.io/en/latest/api.html

Given that you have nice numpydoc style docstrings for your functions and classes, it'd be nice to also be able to see them in your automatically generated docs.

This repo contains a setup similar to yours (functions and classes documented via numpydoc, built via sphinx and readthedocs), so you may find it useful to debug your own docs: https://pyprep.readthedocs.io/en/latest/api.html

xref: https://github.com/openjournals/joss-reviews/issues/4840

edeno commented 1 year ago

@sappelhoff function signatures are now fixed in the docs: https://spectral-connectivity.readthedocs.io/en/latest/_autosummary/spectral_connectivity.html