Skip to content

DOC: Create documentation #7

Open
Open
DOC: Create documentation#7

Description

@KCollins
KCollins
opened on Jun 22, 2025
  • create a docs directory for the documentation
  • add installation instructions
  • add citation instructions
  • convert README.md to README.rst
  • create an API from the docstrings
  • add usage examples
  • provide a link to the notebooks
  • publish online

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions