diff --git a/docs/examples/irradiance-transposition/plot_ghi_transposition.py b/docs/examples/irradiance-transposition/01_ghi_transposition.py similarity index 100% rename from docs/examples/irradiance-transposition/plot_ghi_transposition.py rename to docs/examples/irradiance-transposition/01_ghi_transposition.py diff --git a/docs/examples/irradiance-transposition/plot_transposition_gain.py b/docs/examples/irradiance-transposition/02_transposition_gain.py similarity index 100% rename from docs/examples/irradiance-transposition/plot_transposition_gain.py rename to docs/examples/irradiance-transposition/02_transposition_gain.py diff --git a/docs/examples/irradiance-transposition/plot_interval_transposition_error.py b/docs/examples/irradiance-transposition/03_interval_transposition_error.py similarity index 100% rename from docs/examples/irradiance-transposition/plot_interval_transposition_error.py rename to docs/examples/irradiance-transposition/03_interval_transposition_error.py diff --git a/docs/examples/irradiance-transposition/use_perez_modelchain.py b/docs/examples/irradiance-transposition/04_use_perez_modelchain.py similarity index 100% rename from docs/examples/irradiance-transposition/use_perez_modelchain.py rename to docs/examples/irradiance-transposition/04_use_perez_modelchain.py diff --git a/docs/examples/irradiance-transposition/plot_mixed_orientation.py b/docs/examples/irradiance-transposition/05_mixed_orientation.py similarity index 100% rename from docs/examples/irradiance-transposition/plot_mixed_orientation.py rename to docs/examples/irradiance-transposition/05_mixed_orientation.py diff --git a/docs/examples/irradiance-transposition/plot_seasonal_tilt.py b/docs/examples/irradiance-transposition/06_seasonal_tilt.py similarity index 100% rename from docs/examples/irradiance-transposition/plot_seasonal_tilt.py rename to docs/examples/irradiance-transposition/06_seasonal_tilt.py diff --git a/docs/examples/irradiance-transposition/plot_rtranpose_year.py b/docs/examples/irradiance-transposition/07_rtranspose_year.py similarity index 100% rename from docs/examples/irradiance-transposition/plot_rtranpose_year.py rename to docs/examples/irradiance-transposition/07_rtranspose_year.py diff --git a/docs/examples/irradiance-transposition/plot_rtranpose_limitations.py b/docs/examples/irradiance-transposition/08_rtranspose_limitations.py similarity index 100% rename from docs/examples/irradiance-transposition/plot_rtranpose_limitations.py rename to docs/examples/irradiance-transposition/08_rtranspose_limitations.py diff --git a/docs/sphinx/source/contributing/style_guide.rst b/docs/sphinx/source/contributing/style_guide.rst index 4eea571eda..954ed3495a 100644 --- a/docs/sphinx/source/contributing/style_guide.rst +++ b/docs/sphinx/source/contributing/style_guide.rst @@ -350,3 +350,15 @@ Here is a starter template for new examples: For more details, see the sphinx-gallery `docs `_. + +Controlling Example Order +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Examples within a subsection are ordered alphabetically by filename. +To control their position explicitly, prefix filenames with numbers +(e.g., ``01_``, ``02_``). + +For more advanced ordering options, see the sphinx-gallery +`documentation `_. + +