Add documentation framework

[patrick-5546]

Use Material for MkDocs to host documentation

To do

• Base it off my previous website: https://github.com/UBCSailbot/docs
• Use mkdocstrings to generate documentation from sources
• Set up versioning: https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning
  • Learnings from Set up versioning notes#32
• markdown vs code extensions
• lint, build, publish docs in workflow
  • Integrate with tox
  • Use default configuration file names
• Move contents of CONTRIBUTING.md to infrastructure page of docs
  • Or use snippet
• Add offline plugin
• Create files in page tree
• Write developer guide
• Comment code

Page tree

• Home
  • License
• User Guide
  • Installation
  • Getting Started
  • Commands
  • Configuration
• Code Reference
  • Coverage Report (see https://mkdocstrings.github.io/coverage/)
• Development
  • Contributing
    • Setup
    • Environments
      • Test
      • Lint
      • ...
  • Adapting this Repository Template
  • VS Code Integration
  • GitHub Actions Integration
  • Create a Release