Skip to content

Improve documentation #143

@kallewesterling

Description

@kallewesterling
  • Set up industry standard package for documentation, e.g. Sphinx
  • Set up appropriate file structure for Sphinx, and move notebooks into the documentation (as worked examples)
  • Add instructions on how to contribute to the codebase
  • Add instructions to the README on how to build the documentation for the codebase (for folks who want to contribute to the documentation, e.g. "How do I add another worked example to the repository?")

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions