Skip to content

Setup documentation system to keep track of implemented API #17

Closed
Closed
Setup documentation system to keep track of implemented API#17
Assignees
ismael-mendoza
Labels
docsImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed
Milestone
First Paper

Description

@EiffL
EiffL
opened on 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.

Activity

  1. EiffL
    added
    docsImprovements or additions to documentation
    good first issueGood for newcomers
    help wantedExtra attention is needed
    on Jun 14, 2022
  2. EiffL
    added this to the demo1.py milestone on Jun 14, 2022

  3. ismael-mendoza commented on Sep 13, 2024

    @ismael-mendoza
    ismael-mendoza
    on Sep 13, 2024
    Collaborator

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

  4. ismael-mendoza
    modified the milestones: demo1.py, First Paper on Feb 6, 2026
  5. ismael-mendoza
    self-assigned this
    on Apr 7, 2026
  6. ismael-mendoza
    linked a pull request that will close this issueWIP: Add documentation site with Material for MkDocs #204on Apr 7, 2026

  7. beckermr commented on May 1, 2026

    @beckermr
    beckermr
    on May 1, 2026
    Collaborator

    xref: #226

  8. beckermr commented on May 1, 2026

    @beckermr
    beckermr
    on May 1, 2026
    Collaborator

    The last bit here is to automate the api percentage listing. Then we can close this issue.

  9. beckermr commented on May 3, 2026

    @beckermr
    beckermr
    on May 3, 2026
    Collaborator

    Done in #228

  10. beckermr
    closed this as completedon May 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

docsImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions