Skip to content

Improve CLI subcommand organisation and convert docs to Material for Mkdocs

Latest

Choose a tag to compare

@github-actions github-actions released this 19 Aug 22:06
5ef4730

Contents (#738)

IMPORTANT: There is 1 breaking change.

Enhancements

  • Update version compatibility table script for markdown format

Dependencies

  • Add mkdocs-material
  • Add mkdocs-glightbox to provide image zooming to docs
  • Remove dependencies and config from old documentation
  • Add tabulate for version table script

Refactoring

  • 💥 BREAKING CHANGE: Replace octue twined start CLI subcommand with octue twined service start subcommand

Reversions

  • Revert "REF: Remove google_crc32c warning suppression"

Other

  • Convert documentation from restructured text (RST) to markdown (MD)
  • Use mkdocs and Material for Mkdocs to build and theme documentation
  • Document using TWINED_SERVICES_TOPIC_NAME envvar
  • Disable sphinx pre-commit step
  • Update CLI printout in readme
  • Replace "Octue SDK" with "Twined" in docs
  • Move CONTRIBUTING.md to 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