search

benbovy / spherely

Manipulation and analysis of geometric objects on the sphere.
https://spherely.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
119 stars 8 forks source link

Add documentation #9

Closed benbovy closed 1 year ago

benbovy commented 1 year ago

Unfortunately it is not possible yet to reuse the pyi type stubs with sphinx.

https://github.com/sphinx-doc/sphinx/issues/7630 https://github.com/tox-dev/sphinx-autodoc-typehints/issues/161

benbovy commented 1 year ago

I'm going to merge this. I added an API reference section with docstrings for all API implemented so far. I plan to add some installation instructions + other useful details in a follow-up PR.