Skip to content

Build ltitop documentation #13

Description

@hidmic

Rationale

As of today, ltitop has no documentation. That makes it useless for pretty much anyone.

Definition of Done

  • Document project public APIs
  • Document project itself
    • Add quickstart?
    • Add overview
    • Add purpose
    • Add tutorial?
  • Build project documentation using Sphinx
  • Use RTD to publish
    • Ensure rebuilds on push to master (use Github webhook).
  • Populate README.md
    • Add short overview
    • Add project logo
    • Add badges
    • Link to docs

Additional considerations

See this blog post for useful pointers.

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 documentationepicA large body of work

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions