Before commitΒΆ

Run the commands in project shell/project folder.

hatch shell
  1. Check formatting with ruff by running command:

    hatch fmt -l
    
  2. Check typing with mypy by running command:

    hatch run lint:typing
    
  3. Run tests with pytest by running command:

    hatch run test
    
  4. Build docs with sphinx by running command:

    hatch run doc:build
    
  5. Delete the generated doc files, Github workflow handles building if necessary (Windows-specific script):

    hatch run doc:delgen