Skip to content

docs: convert Python API docs to Sphinx Material theme #5617

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 25 commits into from
May 28, 2025

Conversation

cwhite911
Copy link
Contributor

Converting the Python API documentation to use the Sphinx Material theme styled to match the main GRASS documentation.

Example View

image

@github-actions github-actions bot added CI Continuous integration Python Related code is in Python HTML Related code is in HTML CSS Related code is in CSS labels May 5, 2025
@petrasovaa
Copy link
Contributor

The heading style causing "Script.Array Module" should be removed

@cwhite911 cwhite911 marked this pull request as ready for review May 6, 2025 19:11
@cwhite911
Copy link
Contributor Author

This PR is at a point where the bulk of the modifications that could be done are done. There are still some remaining issues see Issue #5619 that we can resolve moving forward as we set priorities.

Here are some screenshots to give you an example of the current state.

Getting Started (index.html)

image

Scripting API

image

script package (script.html)

This one is really long, but I think we can improve it by tweaking some of the sphinx-apidoc settings where it will break the code base into smaller files with -e, --separate put documentation for each module on its own page

Screenshot 2025-05-06 at 15-20-41 script package — GRASS Python Library Documentation

PyGRASS API

image

Introduction to Raster classes

image

GRASS Jupyter API (grass.jupyter package)

image

@cwhite911 cwhite911 self-assigned this May 6, 2025
@cwhite911 cwhite911 requested a review from wenzeslaus May 7, 2025 16:31
@github-actions github-actions bot added the markdown Related to markdown, markdown files label May 19, 2025
@cwhite911 cwhite911 requested a review from wenzeslaus May 24, 2025 19:43
Copy link
Contributor

@veroandreo veroandreo left a comment

Choose a reason for hiding this comment

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

Looks fantastic!

@veroandreo veroandreo removed the request for review from wenzeslaus May 28, 2025 15:14
@cwhite911 cwhite911 merged commit 8ef5a06 into OSGeo:main May 28, 2025
25 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in GRASS Markdown Documentation May 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous integration CSS Related code is in CSS docs HTML Related code is in HTML libraries markdown Related to markdown, markdown files module Python Related code is in Python
Projects
Development

Successfully merging this pull request may close these issues.

4 participants