Skip to content

Reorder Irradiance Transposition example gallery section#2688

Open
aman-coder03 wants to merge 5 commits intopvlib:mainfrom
aman-coder03:docs/reorder-irradiance-transposition
Open

Reorder Irradiance Transposition example gallery section#2688
aman-coder03 wants to merge 5 commits intopvlib:mainfrom
aman-coder03:docs/reorder-irradiance-transposition

Conversation

@aman-coder03
Copy link
Contributor

This PR reorders the Irradiance Transposition example gallery section to improve conceptual flow, progressing from basic GHI to POA transposition through modeling topics and finally reverse transposition and its limitations.
Ordering is now explicitly controlled using numeric filename prefixes, consistent with sphinx gallery’s default alphabetical sorting behavior.
Also, updates the contributing style guide to document how example ordering can be controlled within the example gallery.

@aman-coder03
Copy link
Contributor Author

@ramaroesilva can you please have a look at this?

@cwhanse
Copy link
Member

cwhanse commented Feb 9, 2026

I don't think we want to impose an order by adding a prefix counter to the file names. Have you looked at this capability? https://sphinx-gallery.github.io/stable/configuration.html#sorting-gallery-examples

@aman-coder03
Copy link
Contributor Author

i am thinking of using within_subsection_order in conf.py with a custom sort key to control the ordering only within the irradiance-transposition subsection. That way, the filenames remain unchanged and the ordering logic stays centralized in the Sphinx-Gallery configuration.

@aman-coder03 aman-coder03 force-pushed the docs/reorder-irradiance-transposition branch from d583dc8 to 06fe1e1 Compare February 9, 2026 19:41
@aman-coder03
Copy link
Contributor Author

@cwhanse CI failure appears to be due to GitHub API rate limiting (HTTP 429) while downloading external actions, before any project code runs

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

"Irradiance Transposition" documentation section ordering could be improved

2 participants