soft-matter / trackpy

Python particle tracking toolkit
http://soft-matter.github.io/trackpy
Other
445 stars 131 forks source link

DOC: add full API reference using Sphinx recursive option #658

Closed rbnvrw closed 3 years ago

rbnvrw commented 3 years ago

I was trying to build the docs locally and found that we do not have an overview of the full trackpy API. This adds a toctree at the bottom of the API page where you can click through all files / modules and functions. I think it is a useful addition because also the less often used functions are browse-able through the docs in this way.

caspervdw commented 3 years ago

Thanks @rbnvrw . I’ll merge, but let’s have a close look at the result and see what functions we actually want to document. Not all is part of the external API.