Skip to content

Add package documentation and deploy to Read The Docs

Benoît SEIGNOVERT requested to merge add-explicit-docs into main
  • Change package name description from majis to majis-ops (import remains unchanged)
  • Reorganize hatch environments (no longer in a single .venv)
  • Bump hatch min version (now 1.12)
  • Remove CI build step (only use linter stage)
  • Split ruff check and format scripts
  • Add new docs development environment in hatch configuration
  • Add jupyter-book dependency as the main docs dependency.
  • Add explicit documentation in docs/
  • Add documentation for read_itl, Timeline and majis-itl CLI.
  • Add API reference for all [sub]modules.
  • Fix minor typos (mainly in docstrings)
  • Add status badges to the project
  • Add new package logo
  • Trigger CI only if python files are changed
  • Disable tests on multiple python version in CI when MR is draft
  • Add ReadTheDocs deployment webhook in CI deploy stage
  • Add readthedocs.yaml configuration.
  • Push public documentation to readthedocs: majis-ops.readthedocs.io

image

Edited by Benoît SEIGNOVERT

Merge request reports