Skip to content

Add documentation #14

Description

@PythonTryHard

Currently, our docs is garbage: Paragraphs of docstrings does not conform to a format. If we tout our toolkit as a library as well as a CLI app, then we NEED docs.

  • Pick a docs generator.
  • Format docs accordingly.
  • Set up hooks for auto-generating docs. (optional)
  • Host the docs somewhere.

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

    • Status
      In Progress

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions