Visitar URL original
Update docs TOC and Sphinx excludes by C-Achard · Pull Request #3201 · DeepLabCut/DeepLabCut · GitHub
Skip to content
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Revert indent changes
  • Loading branch information
C-Achard committed Feb 6, 2026
commit eee5ad7bac085e15e167236344ae7b398c1cd2b9
210 changes: 105 additions & 105 deletions _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,108 +2,108 @@ format: jb-book
root: README

parts:
- caption: Getting Started
chapters:
- file: docs/UseOverviewGuide
- file: docs/course

- caption: Installation
chapters:
- file: docs/installation
- file: docs/recipes/installTips
- file: docs/docker

- caption: Main User Guides
chapters:
- file: docs/standardDeepLabCut_UserGuide
- 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"
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"
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"
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"
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)"
chapters:
- file: docs/convert_maDLC
- file: docs/recipes/OtherData
- file: docs/recipes/io
- file: docs/recipes/nn
- file: docs/recipes/post
- file: docs/recipes/BatchProcessing
- file: docs/recipes/DLCMethods
- file: docs/recipes/ClusteringNapari
- file: docs/recipes/OpenVINO
- file: docs/recipes/flip_and_rotate
- file: docs/recipes/pose_cfg_file_breakdown
- file: docs/recipes/publishing_notebooks_into_the_DLC_main_cookbook

- caption: Hardware Tips
chapters:
- file: docs/recipes/TechHardware

- caption: DeepLabCut-Live!
chapters:
- file: docs/deeplabcutlive

- caption: "🦄 DeepLabCut Model Zoo"
chapters:
- file: docs/ModelZoo
- file: docs/recipes/UsingModelZooPupil

- caption: DeepLabCut Benchmarking
chapters:
- file: docs/benchmark
- file: docs/pytorch/Benchmarking_shuffle_guide

- caption: "Mission & Contribute"
chapters:
- file: docs/MISSION_AND_VALUES
- file: docs/roadmap
- file: docs/Governance
- file: CONTRIBUTING

- caption: Citations for DeepLabCut
chapters:
- file: docs/citation
- caption: Getting Started
chapters:
- file: docs/UseOverviewGuide
- file: docs/course

- caption: Installation
chapters:
- file: docs/installation
- file: docs/recipes/installTips
- file: docs/docker

- caption: Main User Guides
chapters:
- file: docs/standardDeepLabCut_UserGuide
- 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"
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"
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"
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"
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)"
chapters:
- file: docs/convert_maDLC
- file: docs/recipes/OtherData
- file: docs/recipes/io
- file: docs/recipes/nn
- file: docs/recipes/post
- file: docs/recipes/BatchProcessing
- file: docs/recipes/DLCMethods
- file: docs/recipes/ClusteringNapari
- file: docs/recipes/OpenVINO
- file: docs/recipes/flip_and_rotate
- file: docs/recipes/pose_cfg_file_breakdown
- file: docs/recipes/publishing_notebooks_into_the_DLC_main_cookbook

- caption: Hardware Tips
chapters:
- file: docs/recipes/TechHardware

- caption: DeepLabCut-Live!
chapters:
- file: docs/deeplabcutlive

- caption: "🦄 DeepLabCut Model Zoo"
chapters:
- file: docs/ModelZoo
- file: docs/recipes/UsingModelZooPupil

- caption: DeepLabCut Benchmarking
chapters:
- file: docs/benchmark
- file: docs/pytorch/Benchmarking_shuffle_guide

- caption: "Mission & Contribute"
chapters:
- file: docs/MISSION_AND_VALUES
- file: docs/roadmap
- file: docs/Governance
- file: CONTRIBUTING

- caption: Citations for DeepLabCut
chapters:
- file: docs/citation