Skip to content

Group remote-dataset cards on the index page by category - #152

Merged
Esteban82 merged 3 commits into
mainfrom
reorganize-remote-datasets-index
Aug 31, 2026
Merged

Group remote-dataset cards on the index page by category#152
Esteban82 merged 3 commits into
mainfrom
reorganize-remote-datasets-index

Conversation

@Esteban82

Copy link
Copy Markdown
Member

Summary

The landing page (docs/index.rst) listed all 22 remote datasets in a single flat grid. This PR groups the cards into labeled sections (that mirror the categories already used in the gmtserver-admin):

  • Miscellaneous — Age, Distance to Shoreline, Mask
  • Gravity — Free-Air Anomaly (+ error), Deflections (E-W, S-N), Vertical Gravity Gradient
  • Geodesy — Geoid, Mean Dynamic Topography, Mean Sea Surface
  • Magnetics — EMAG2, WDMAM
  • Topography — GEBCO, IGPP Relief, SRTM
  • Images — Day/Night
  • Other Celestial Bodies — Mars, Moon, Mercury, Pluto, Venus

The single hidden toctree was also split into one toctree per section (each with its own :caption:), so the same groups show up as separate blocks in the left sidebar navigation instead of one long undifferentiated list.

The landing page listed all 22 datasets in one flat grid, in a
historical/ad-hoc order that mixed relief, gravity, magnetics, and
imagery together. Split it into labeled sections (Miscellaneous,
Gravity, Geodesy, Magnetics, Topography, Images, Other Celestial
Bodies) that mirror the categories already used by the gmtserver-admin
Makefile, and split the single hidden toctree into one per section so
the same groups show up in the left sidebar navigation.
@Esteban82
Esteban82 requested review from a team and joa-quim August 31, 2026 19:25
@Esteban82 Esteban82 added the documentation Improvements or additions to documentation label Aug 31, 2026
@joa-quim

Copy link
Copy Markdown
Member

I thinks this will be good but I would like to see how it looks.

@Esteban82

Copy link
Copy Markdown
Member Author
image

@Esteban82

Copy link
Copy Markdown
Member Author

I should probably use alphabetical order.

Geodesy, Gravity, Images, Magnetics, Miscellaneous, Other Celestial
Bodies, Topography - both the visible grid sections and the
corresponding hidden toctree captions in the sidebar.
@Esteban82

Copy link
Copy Markdown
Member Author

Now in alphabetical order.

@joa-quim joa-quim left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, looks good

@Esteban82
Esteban82 merged commit 044ee23 into main Aug 31, 2026
1 check passed
@Esteban82
Esteban82 deleted the reorganize-remote-datasets-index branch August 31, 2026 20:58
Comment thread docs/index.rst

.. toctree::
:hidden:
:caption: Topography

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the groupping of the datasets, but I feel it's not optimal to have the Earth relief grids as the last entry. By renaming the heading to "Elevation and bathymetry", it could be moved to the top following the alphabetical order.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants