Skip to content

Add generated documentation #37

@aawdls

Description

@aawdls

Add a docs build equivalent to the use of Sphinx in the Skeleton.

  • Generate API docs based on code comments
  • Make space for an introduction page
  • How-to for install
  • How-to for use in another project
  • Make space for architecture decision records

Build with github actions and publish to github pages

My first google result was TypeDoc, but another tool may be more suitable

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions