Skip to content

Latest commit

 

History

History
18 lines (14 loc) · 378 Bytes

README.md

File metadata and controls

18 lines (14 loc) · 378 Bytes

SML docs repository

Requirements

  • Hatch >= 19.4

Commands

  • hatch run dev:build Build Sphinx documentation into build/html docs
  • hatch run dev:watch Starts Sphinx autobuilder - HTTP hosting with auto rebuild and reload
  • hatch run dev:check Checks quality of documentation using linters

Linters

  • sphinx-lint
  • Vale with Alex package