Skip to content

Set up docs/CI in repo #7

@kelsey-wong

Description

@kelsey-wong

See Anish's recommendations (from #tlm Slack channel):

  • Project manager and build backend: Hatch and Hatchling
    • I see you're already using this
  • Installer: uv (via installer = "uv" option in pyproject.toml)
    • Lot faster than the default pip installer
    • For a Python library using Hatchling as the build system, I don't think you need the .python-version or uv.lock
  • Code quality and CI: GitHub Actions, Mypy, Ruff (via hatch fmt), Pytest (via hatch test), Codecov
  • Docs: mkdocs-material and mkdocstrings-python, built in GitHub Actions and hosted using GitHub pages (via artifact, not branch)
    • Popular libraries like Pydantic AI and DSPy use mkdocs-material, you could take inspiration from their configuration. I also used this documentation system for a personal project a couple months ago, feel free to copy configurations from there.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions