Improve CLI subcommand organisation and convert docs to Material for Mkdocs
Contents (#738)
IMPORTANT: There is 1 breaking change.
Enhancements
- Update version compatibility table script for markdown format
Dependencies
- Add
mkdocs-material - Add
mkdocs-glightboxto provide image zooming to docs - Remove dependencies and config from old documentation
- Add
tabulatefor version table script
Refactoring
- 💥 BREAKING CHANGE: Replace
octue twined startCLI subcommand withoctue twined service startsubcommand
Reversions
- Revert "REF: Remove
google_crc32cwarning suppression"
Other
- Convert documentation from restructured text (RST) to markdown (MD)
- Use
mkdocsand Material for Mkdocs to build and theme documentation - Document using
TWINED_SERVICES_TOPIC_NAMEenvvar - Disable sphinx pre-commit step
- Update CLI printout in readme
- Replace "Octue SDK" with "Twined" in docs
- Move
CONTRIBUTING.mdto repo root and update it
Upgrade instructions
💥 Replace `octue twined start` CLI subcommand with `octue twined service start` subcommand
Use octue twined service start instead of octue twined start