pvlib-python icon indicating copy to clipboard operation
pvlib-python copied to clipboard

"Irradiance Transposition" documentation section ordering could be improved

Open ramaroesilva opened this issue 5 months ago • 2 comments

Issue The section ordering of Irradiance Transposition documentation in Example Gallery is not very fluid, in my opinion.

Current situation

  1. Mixed Orientation
  2. Reverse transposition using one year of hourly data
  3. GHI to POA Transposition
  4. Seasonal Tilt
  5. Use different Perez coefficients with the ModelChain
  6. Reverse transposition limitations
  7. Modeling with interval averages
  8. Modeling Transposition Gain

Proposal

  1. GHI to POA Transposition
  2. Modeling Transposition Gain
  3. Modeling with interval averages (maybe could come before the one above)
  4. Use different Perez coefficients with the ModelChain
  5. Mixed Orientation
  6. Seasonal Tilt
  7. Reverse transposition using one year of hourly data6.
  8. Reverse transposition limitations

ramaroesilva avatar Jul 26 '25 11:07 ramaroesilva

sphinx-gallery allows specifying the order, see https://sphinx-gallery.github.io/stable/configuration.html#own-sort-keys

A PR to reorder the irradiance transposition section would be welcome!

Thinking more broadly, perhaps the other sections should be reordered as well, and one step further, the ordering of the sections themselves...

kandersolar avatar Jul 31 '25 18:07 kandersolar

This would be a nice improvement! I'd love if this contributing section on adding examples was also updated to reflect the steps required to set the position of new examples and link to the relevant sphinx-gallery documentation.

This doc page source file is docs/sphinx/source/contributing/style_guide.rst

echedey-ls avatar Jul 31 '25 18:07 echedey-ls