docs: add developer documentation infrastructure by arashsm79 · Pull Request #3187 · DeepLabCut/DeepLabCut

arashsm79 · 2026-01-22T10:22:42Z

Adds MkDocs Material infrastructure for developer documentation alongside existing Jupyter Book user docs.
MkDocs Material is a very popular documentation engine for Python projects (Pydantic, Ultralytics, Supervision, and many more) with modern features.
This also allows us to easily migrate to Zensical once it is ready.
Enables autogenerated API documentation from docstrings via mkdocstrings.
Critical for contributors and advanced users needing low-level implementation details and type signatures.
We can later configure mike plugin for future version management; each release will get dedicated documentation snapshots so users can reference docs matching their installed version
Updated GitHub Actions workflow to build and deploy developer docs to /dev path
Separates concerns: Jupyter Book for users with tutorials/guides, MkDocs for developers and API reference/architecture.
Documentation pages can be populated in the future. For now it contains the information in pose_estimation_pytorch/README.md. @C-Achard @deruyter92
The style and navigations can also be easily adapted.

arashsm79 added 3 commits January 20, 2026 00:18

docs: set up developer documentation

54bb9a1

docs: add stub files for dev documentation

1cb16c9

docs: add preliminary dev docs

3148252

deruyter92 added enhancement New feature or request documentation documentation updates/comments labels Feb 2, 2026

C-Achard mentioned this pull request Feb 3, 2026

[meta] docs DeepLabCut/DeepLabCut-live#78

Open

5 tasks

Provide feedback