Skip to content

Commit c983d0a

Browse files
committed
DOC: Reorder Irradiance Transposition example gallery section
1 parent 802dfc6 commit c983d0a

File tree

9 files changed

+12
-0
lines changed

9 files changed

+12
-0
lines changed

docs/examples/irradiance-transposition/plot_ghi_transposition.py renamed to docs/examples/irradiance-transposition/01_ghi_transposition.py

File renamed without changes.

docs/examples/irradiance-transposition/plot_transposition_gain.py renamed to docs/examples/irradiance-transposition/02_transposition_gain.py

File renamed without changes.

docs/examples/irradiance-transposition/plot_interval_transposition_error.py renamed to docs/examples/irradiance-transposition/03_interval_transposition_error.py

File renamed without changes.

docs/examples/irradiance-transposition/use_perez_modelchain.py renamed to docs/examples/irradiance-transposition/04_use_perez_modelchain.py

File renamed without changes.

docs/examples/irradiance-transposition/plot_mixed_orientation.py renamed to docs/examples/irradiance-transposition/05_mixed_orientation.py

File renamed without changes.

docs/examples/irradiance-transposition/plot_seasonal_tilt.py renamed to docs/examples/irradiance-transposition/06_seasonal_tilt.py

File renamed without changes.

docs/examples/irradiance-transposition/plot_rtranpose_year.py renamed to docs/examples/irradiance-transposition/07_rtranspose_year.py

File renamed without changes.

docs/examples/irradiance-transposition/plot_rtranpose_limitations.py renamed to docs/examples/irradiance-transposition/08_rtranspose_limitations.py

File renamed without changes.

docs/sphinx/source/contributing/style_guide.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -350,3 +350,15 @@ Here is a starter template for new examples:
350350
351351
For more details, see the sphinx-gallery
352352
`docs <https://sphinx-gallery.github.io/stable/syntax.html#embedding-rst>`_.
353+
354+
Controlling Example Order
355+
~~~~~~~~~~~~~~~~~~~~~~~~~
356+
357+
Examples within a subsection are ordered alphabetically by filename.
358+
To control their position explicitly, prefix filenames with numbers
359+
(e.g., ``01_``, ``02_``).
360+
361+
For more advanced ordering options, see the sphinx-gallery
362+
`documentation <https://sphinx-gallery.github.io/stable/configuration.html#own-sort-keys>`_.
363+
364+

0 commit comments

Comments
 (0)