Skip to content

[WIP] DLC 3.0 - Review documentation #2881

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
Merged
MMathisLab merged 20 commits into from
Feb 28, 2025
Merged

[WIP] DLC 3.0 - Review documentation #2881

MMathisLab merged 20 commits into from
Feb 28, 2025

Conversation

@maximpavliv
Copy link
Contributor

@maximpavliv maximpavliv commented Feb 14, 2025 •
edited
Loading

Updated documentation for the upcoming release of DLC 3.0

@maximpavliv maximpavliv added WORK IN PROGRESS! developers are currently working on this feature... stay tuned. documentation documentation updates/comments DLC3.0🔥 labels Feb 14, 2025
@maximpavliv maximpavliv changed the title [WIP] Reviewed documentation [WIP] DLC 3.0 - Review documentation Feb 14, 2025
@maximpavliv
Copy link
Contributor Author

maximpavliv commented Feb 14, 2025

If you want to review changes, the easiest way to go is to open https://deeplabcut.github.io/DeepLabCut and a locally-built version in browsers side-by-side and view the difference in HTML files.

The most important files to review (and the ones with the most changes in content) and where we could use feedback the most are the single and multi-animal user guides.

To build the docs locally, you can run.

git checkout docs_merge
conda create -n deeplabcut-docs python=3.10
conda activate deeplabcut-docs
pip install ".[docs]" jupyter-book sphinxcontrib-mermaid

jupyter-book build .

AlexEMG
AlexEMG reviewed Feb 16, 2025
View reviewed changes
AlexEMG
AlexEMG reviewed Feb 16, 2025
View reviewed changes
@maximpavliv maximpavliv mentioned this pull request Feb 21, 2025
Merged
@MMathisLab MMathisLab merged commit e1d2b25 into pytorch_dlc Feb 28, 2025
1 check passed
@MMathisLab MMathisLab deleted the docs_merge branch February 28, 2025 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AlexEMG AlexEMG AlexEMG left review comments

@MMathisLab MMathisLab MMathisLab approved these changes

Assignees

No one assigned

Labels

DLC3.0🔥 documentation documentation updates/comments WORK IN PROGRESS! developers are currently working on this feature... stay tuned.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@maximpavliv @AlexEMG @MMathisLab @n-poulsen