Skip to content

Update docs TOC and Sphinx excludes #3201

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

Merged
C-Achard merged 6 commits into from
Feb 16, 2026
Merged

Update docs TOC and Sphinx excludes #3201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
69a3ee3
Update docs TOC and Sphinx excludes
C-Achard Feb 6, 2026
eee5ad7
Revert indent changes
C-Achard Feb 6, 2026
612e5a3
Update _toc.yml
C-Achard Feb 6, 2026
32ab49c
Merge branch 'main' into cy/fix-toc-jb1.0.4post1
C-Achard Feb 10, 2026
0f94397
Update _config.yml
C-Achard Feb 10, 2026
9a7193b
Merge branch 'main' into cy/fix-toc-jb1.0.4post1
C-Achard Feb 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions _config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ sphinx:
config:
autodoc_mock_imports: ["wx", "matplotlib", "qtpy", "PySide6", "napari", "shiboken6"]
mermaid_output_format: raw
exclude_patterns:
- ".venv/**"
- "venv/**"
- "**/site-packages/**"
- "**/_build/**"
extra_extensions:
- numpydoc
- sphinxcontrib.mermaid
Expand Down
26 changes: 16 additions & 10 deletions _toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
format: jb-book
root: README

parts:
- caption: Getting Started
chapters:
- file: docs/UseOverviewGuide
- file: docs/course
Comment thread
C-Achard marked this conversation as resolved.

- caption: Installation
chapters:
- file: docs/installation
Expand All @@ -17,50 +19,52 @@ parts:
- file: docs/maDLC_UserGuide
- file: docs/Overviewof3D
- file: docs/HelperFunctions

- caption: Graphical User Interfaces (GUIs)
chapters:
- file: docs/gui/PROJECT_GUI
- file: docs/gui/napari_GUI

- caption: DLC3 PyTorch Specific Docs
chapters:
- file: docs/pytorch/user_guide.md
- file: docs/pytorch/pytorch_config.md
- file: docs/pytorch/architectures.md

- caption: Quick Start Tutorials
chapters:
- file: docs/quick-start/single_animal_quick_guide
- file: docs/quick-start/tutorial_maDLC
- caption: 🚀 Beginner's Guide to DeepLabCut

- caption: "🚀 Beginner's Guide to DeepLabCut"
chapters:
- file: docs/beginner-guides/beginners-guide
- file: docs/beginner-guides/manage-project
- file: docs/beginner-guides/labeling
- file: docs/beginner-guides/Training-Evaluation
- file: docs/beginner-guides/video-analysis
- caption: 🚀 Main Demo Notebooks

- caption: "🚀 Main Demo Notebooks"
chapters:
- file: examples/COLAB/COLAB_DEMO_SuperAnimal
- file: examples/COLAB/COLAB_DEMO_mouse_openfield
- file: examples/COLAB/COLAB_3miceDemo
- file: examples/COLAB/COLAB_HumanPose_with_RTMPose



- caption: 🚀 Notebooks For Your Data
- caption: "🚀 Notebooks For Your Data"
chapters:
- file: examples/COLAB/COLAB_YOURDATA_SuperAnimal
- file: examples/COLAB/COLAB_YOURDATA_TrainNetwork_VideoAnalysis
- file: examples/COLAB/COLAB_YOURDATA_maDLC_TrainNetwork_VideoAnalysis

- caption: 🚀 Special Feature Demos
- caption: "🚀 Special Feature Demos"
chapters:
- file: examples/COLAB/COLAB_transformer_reID
- file: examples/COLAB/COLAB_BUCTD_and_CTD_tracking
- file: examples/JUPYTER/Demo_3D_DeepLabCut
- file: examples/COLAB/COLAB_DLC_ModelZoo

- caption: 🧑‍🍳 Cookbook (detailed helper guides)
- caption: "🧑‍🍳 Cookbook (detailed helper guides)"
chapters:
- file: docs/convert_maDLC
- file: docs/recipes/OtherData
Expand All @@ -78,10 +82,12 @@ parts:
- caption: Hardware Tips
chapters:
- file: docs/recipes/TechHardware

- caption: DeepLabCut-Live!
chapters:
- file: docs/deeplabcutlive
- caption: 🦄 DeepLabCut Model Zoo

- caption: "🦄 DeepLabCut Model Zoo"
chapters:
- file: docs/ModelZoo
- file: docs/recipes/UsingModelZooPupil
Expand All @@ -91,7 +97,7 @@ parts:
- file: docs/benchmark
- file: docs/pytorch/Benchmarking_shuffle_guide

- caption: Mission & Contribute
- caption: "Mission & Contribute"
chapters:
- file: docs/MISSION_AND_VALUES
- file: docs/roadmap
Expand Down