8000 docs: add developer documentation infrastructure by arashsm79 · Pull Request #3187 · DeepLabCut/DeepLabCut · GitHub
[go: up one dir, main page]
Skip to content

docs: add developer documentation infrastructure #3187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
arashsm79 wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

docs: add developer documentation infrastructure #3187

arashsm79 wants to merge 3 commits into from
+1,108 −1

Conversation

@arashsm79
Copy link
Contributor
@arashsm79 arashsm79 commented Jan 22, 2026
  • 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@arashsm79
0