Update docs TOC and Sphinx excludes#3201
Merged
C-Achard merged 6 commits intoDeepLabCut:mainfrom Feb 16, 2026
Merged
Conversation
Add Sphinx exclude_patterns to _config.yml to ignore virtual environments, site-packages, and build directories during doc builds (".venv/**", "venv/**", "**/site-packages/**", "_build/**", "**/_build/**"). Reformat _toc.yml into a proper jb-book "parts:" structure with correctly nested captions and chapters, normalize emoji-bearing captions with quotes, and restore many documentation sections. Also add a placeholder "DLC-Live!" entry with nested chapters/sections for the dlc-live GUI documentation. These changes clean up the table of contents and prevent unrelated files from being included in the documentation build.
15 tasks
15 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Jupyter Book documentation configuration to reduce build noise and improve compatibility with newer jupyter-book<2 TOC parsing.
Changes:
- Reformats
_toc.ymlto a clearerparts:structure and quotes emoji-containing captions. - Adds Sphinx
exclude_patternsin_config.ymlto ignore venv/site-packages/build directories during docs builds.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
_toc.yml |
Normalizes TOC structure/formatting (notably captions and part boundaries). |
_config.yml |
Excludes common non-doc directories from Sphinx discovery to speed builds and avoid accidental inclusion. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
jupyter-book<2version.This will also speed up local and potentially CI docs build.
TODO
Related
Required by/upstream of #3206. If 3206 is merged this PR is not relevant anymore.
Details