Organize colormaps documentation into meaningful categories#619
Draft
Organize colormaps documentation into meaningful categories#619
Conversation
Agent-Logs-Url: https://github.com/gallantlab/pycortex/sessions/ebd083ec-943e-49c1-bc79-a876c113b530 Co-authored-by: mvdoc <6150554+mvdoc@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add organized documentation on colormaps
Organize colormaps documentation into meaningful categories
Apr 4, 2026
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
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.
The colormaps docs page was an unsorted flat list of ~170 colormap images with no context on when or why to use each one.
Changes
docs/colormap_rst.py: Rewrote the RST generator to produce a categorized page modeled after matplotlib's colormap documentation1D colormap sections
viridis,plasma,inferno,magmaBlues,hot,fire,autumn, …RdBu,BuWtRd,coolwarm,seismic, …hsv,Retinotopy_RYBCR,RGrB_tsiSet1–Set3,Accent,jet,rainbow, …HCP_MMP1,freesurfer_aseg_256, …2D colormap sections (particularly improved per the issue)
BuOr_2D,PU_RdBu_covar,RdBu_2D, …Retinotopy_HSV_alpha,eccentricity_alpha_2D, …autumn_alpha,plasma_alpha,seismic_alpha, …BROYG_2D,custom2D_RB_bins_256Each section includes a short description of the use-case. Dimension detection (
is_2d()) now reads each image's shape dynamically rather than relying on name-pattern matching. The generatedcolormaps.rstis excluded via.gitignoreand rebuilt at docs-build time.