Skip to content

DOC: Create documentation #7

@KCollins

Description

@KCollins
  • 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

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