DOC fix build warnings - #673
Merged
Merged
Conversation
docs/userguide/webgl.rst wasn't linked from any toctree, so it never appeared in the built docs even though roidraw.rst treats it as a prerequisite. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
kroq-gar78
marked this pull request as ready for review
August 20, 2026 20:58
mvdoc
approved these changes
Aug 20, 2026
mvdoc
left a comment
mvdoc
left a comment
Contributor
There was a problem hiding this comment.
LGTM -- just re-running make html locally to check
mvdoc
added a commit
to mvdoc/pycortex
that referenced
this pull request
Aug 21, 2026
* origin/main: (44 commits) WebGL viewer: make opacity slider and `o` toggle work for Vertex data (gallantlab#685) docs(mapper): add get_mapper docstring (gallantlab#686) ENH add types for dataset classes (BrainData, Dataview, ...) (gallantlab#669) Allow viewer data to be updated in real-time (gallantlab#675) FIX: fix minor bug in handling of vmin and vmax when not specified (replaces old cast code) (gallantlab#681) docs: correct the sulcus install instructions, which destroyed existing sulci (gallantlab#657) WebGL viewer: fix help-menu shortcut display (gallantlab#642) MNT ignore docs build outputs written into the source tree (gallantlab#680) DOC fix build warnings (gallantlab#673) webgl: bind an OS-assigned ephemeral port for the viewer server (gallantlab#676) ENH add types for Database and transforms (gallantlab#667) MNT remove obsolete Python 2 syntax, add some types (gallantlab#666) Bump JamesIves/github-pages-deploy-action from 4.8.0 to 4.9.0 (gallantlab#671) Bump actions/setup-python from 6 to 7 (gallantlab#661) docs: document in-browser sulcus drawing (pycortex-roidraw v0.4.0) (gallantlab#656) ENH Pure-python surf2surf matrix (direct nnfr construction) (gallantlab#651) Bump actions/cache from 5 to 6 (gallantlab#654) webgl: fix overlay/label async texture-bake races (complete) (gallantlab#653) docs: add in-browser ROI drawing (pycortex-roidraw) page (gallantlab#652) FIX: update BuWtRd and BuWtRd_alpha colormaps to have pure white at center, more sensible for biphasic data (gallantlab#649) ... # Conflicts: # cortex/quickflat/composite.py # cortex/utils.py # cortex/webgl/resources/js/shaderlib.js # cortex/webgl/view.py
alexhuth
pushed a commit
that referenced
this pull request
Aug 21, 2026
* docs: fix compositing functions, re-order entries * docs: uncomment dataset page in toctree * docs: fix :doc: role in ROI vertices example * docs: fix section levels so Masks heading renders * docs: add orphaned webgl user guide page to toctree docs/userguide/webgl.rst wasn't linked from any toctree, so it never appeared in the built docs even though roidraw.rst treats it as a prerequisite. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * docs: fix invalid :module: roles, add missing _static dir * docs: fix short title overlines in example gallery * docs: re-comment dataset page in toctree --------- Co-authored-by: Aditya Vaidya <kroq-gar78@users.noreply.github.com> Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
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.
Summary
quickflatautosummary entries for moved functions (composite.*/utils.*):doc:role in the ROI vertices exampledatabase.rst:module:roles, add missingdocs/_static/dirTest plan
make htmlbuilds clean; total warning count on this branch dropped from 265 (confirmed via containerizedactrun ofbuild_docs.yml) to 230, remaining warnings are pre-existing and unrelated to this PRcomposite.*/utils.*autosummary entries generate and link correctlyuserguide/webgl.rstno longer flagged as excluded from any toctree:module:role errors remain;:mod:cortex.align`` resolves to a real link