JAX-GalSim icon indicating copy to clipboard operation
JAX-GalSim copied to clipboard

Setup documentation system to keep track of implemented API

Open EiffL opened this issue 2 years ago • 1 comments

This is an issue for sphinx-savvy people who love to setup documentation for their Python projects :-) We need to add automated doc building, which we could host on read the docs, and which creates a space for documenting various aspects of this port in addition to the links to the API. In particular, I'm thinking about something similar to the jax documentation and their Sharps Bits section: https://jax.readthedocs.io/en/latest/notebooks/Common_Gotchas_in_JAX.html

Whether we have a mechanism to write these docs in notebooks or in markdown I don't have particular preferences, very happy to discuss options here.

EiffL avatar Jun 14 '22 22:06 EiffL

Partially addressed by @beckermr in #89, perhaps later we can add more docs

ismael-mendoza avatar Sep 13 '24 00:09 ismael-mendoza