Skip to content

Creating proper documentation #13

Description

@cryptaliagy

Creating the proper sphinx docs that can be used for documentation will help build the proper API docs, as well as usage docs for a MAN page (since Sphinx does support that).

Some helpful packages:

  • sphinx_autodoc_typehints
  • myst_parser
  • sphinx_rtd_theme

Need to look up a proper Click parser extension that can auto-document the usage

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

    documentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions