bjlittle / geovista

Cartographic rendering and mesh analytics powered by PyVista
https://geovista.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
143 stars 22 forks source link

docs: auto-generate gallery carousel #867

Closed bjlittle closed 1 month ago

bjlittle commented 1 month ago

🚀 Pull Request

Description

This pull-request auto-generates the documentation landing page gallery carousel, but only if the sphinx-gallery has built the gallery of examples.

It achieves this by registering a callback with sphinx to generate sphinx-design RST in the docs/src/gallery-carousel.txt file, which is simply included in the docs/src/index.rst using the include directive.

This now achieves a reasonable level of examples automation. By adding an example to the geovista.examples, it will automatically be:

Sweet.

Closes #846

image


codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 91.19%. Comparing base (741e767) to head (9a023b4).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #867 +/- ## ======================================= Coverage 91.19% 91.19% ======================================= Files 58 58 Lines 2943 2943 ======================================= Hits 2684 2684 Misses 259 259 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.