Skip to content

Try alternative Sphinx themes for the PyGMT documentation? #4745

Description

@seisman

The PyGMT documentation has used the Sphinx RTD theme since its first commit. It has worked well, and its relatively infrequent releases (xref: https://github.com/readthedocs/sphinx_rtd_theme/tags) can be viewed as a good thing (stable behavior and little maintenance burden) or a bad thing (missing documentation features).

It may be worth experimenting with alternative themes from the Sphinx Themes gallery. One popular option is the PyData Sphinx Theme, which is used by NumPy, pandas, xarray, and other projects in the PyData ecosystem. It offers a more flexible layout, light/dark mode, and configurable navigation.

I'm not proposing that we replace the current theme. Instead, this issue invites anyone interested to try an alternative in a small proof-of-concept PR and share a documentation preview or screenshots. We can then discuss whether a theme change would be worthwhile.

Metadata

Metadata

Assignees

No one assigned

    Labels

    discussionsNeed more discussion before taking further actions

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions