Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup documentation system to keep track of implemented API #17

Open
Tracked by #87 ...
EiffL opened this issue Jun 14, 2022 · 1 comment
Open
Tracked by #87 ...

Setup documentation system to keep track of implemented API #17

EiffL opened this issue Jun 14, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Milestone

Comments

@EiffL
Copy link
Member

EiffL commented Jun 14, 2022

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 EiffL mentioned this issue Jun 14, 2022
16 tasks
@EiffL EiffL added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Jun 14, 2022
@EiffL EiffL added this to the demo1.py milestone Jun 14, 2022
This was referenced May 30, 2024
@ismael-mendoza
Copy link
Collaborator

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants