From 5867fa988dc4abb72a58cd848c4e57f77030377f Mon Sep 17 00:00:00 2001 From: RDaxini Date: Fri, 14 Mar 2025 15:53:04 -0600 Subject: [PATCH 01/19] subfolders according to current subsections --- docs/sphinx/source/user_guide/{ => extras}/faq.rst | 0 docs/sphinx/source/user_guide/{ => extras}/nomenclature.rst | 0 .../source/user_guide/{ => getting_started}/installation.rst | 0 .../source/user_guide/{ => getting_started}/introtutorial.rst | 0 .../source/user_guide/{ => getting_started}/package_overview.rst | 0 docs/sphinx/source/user_guide/{ => modeling_topics}/bifacial.rst | 0 docs/sphinx/source/user_guide/{ => modeling_topics}/clearsky.rst | 0 docs/sphinx/source/user_guide/{ => modeling_topics}/index.rst | 0 .../sphinx/source/user_guide/{ => modeling_topics}/modelchain.rst | 0 docs/sphinx/source/user_guide/{ => modeling_topics}/pvsystem.rst | 0 .../source/user_guide/{ => modeling_topics}/singlediode.rst | 0 .../source/user_guide/{ => modeling_topics}/timetimezones.rst | 0 .../source/user_guide/{ => modeling_topics}/weather_data.rst | 0 13 files changed, 0 insertions(+), 0 deletions(-) rename docs/sphinx/source/user_guide/{ => extras}/faq.rst (100%) rename docs/sphinx/source/user_guide/{ => extras}/nomenclature.rst (100%) rename docs/sphinx/source/user_guide/{ => getting_started}/installation.rst (100%) rename docs/sphinx/source/user_guide/{ => getting_started}/introtutorial.rst (100%) rename docs/sphinx/source/user_guide/{ => getting_started}/package_overview.rst (100%) rename docs/sphinx/source/user_guide/{ => modeling_topics}/bifacial.rst (100%) rename docs/sphinx/source/user_guide/{ => modeling_topics}/clearsky.rst (100%) rename docs/sphinx/source/user_guide/{ => modeling_topics}/index.rst (100%) rename docs/sphinx/source/user_guide/{ => modeling_topics}/modelchain.rst (100%) rename docs/sphinx/source/user_guide/{ => modeling_topics}/pvsystem.rst (100%) rename docs/sphinx/source/user_guide/{ => modeling_topics}/singlediode.rst (100%) rename docs/sphinx/source/user_guide/{ => modeling_topics}/timetimezones.rst (100%) rename docs/sphinx/source/user_guide/{ => modeling_topics}/weather_data.rst (100%) diff --git a/docs/sphinx/source/user_guide/faq.rst b/docs/sphinx/source/user_guide/extras/faq.rst similarity index 100% rename from docs/sphinx/source/user_guide/faq.rst rename to docs/sphinx/source/user_guide/extras/faq.rst diff --git a/docs/sphinx/source/user_guide/nomenclature.rst b/docs/sphinx/source/user_guide/extras/nomenclature.rst similarity index 100% rename from docs/sphinx/source/user_guide/nomenclature.rst rename to docs/sphinx/source/user_guide/extras/nomenclature.rst diff --git a/docs/sphinx/source/user_guide/installation.rst b/docs/sphinx/source/user_guide/getting_started/installation.rst similarity index 100% rename from docs/sphinx/source/user_guide/installation.rst rename to docs/sphinx/source/user_guide/getting_started/installation.rst diff --git a/docs/sphinx/source/user_guide/introtutorial.rst b/docs/sphinx/source/user_guide/getting_started/introtutorial.rst similarity index 100% rename from docs/sphinx/source/user_guide/introtutorial.rst rename to docs/sphinx/source/user_guide/getting_started/introtutorial.rst diff --git a/docs/sphinx/source/user_guide/package_overview.rst b/docs/sphinx/source/user_guide/getting_started/package_overview.rst similarity index 100% rename from docs/sphinx/source/user_guide/package_overview.rst rename to docs/sphinx/source/user_guide/getting_started/package_overview.rst diff --git a/docs/sphinx/source/user_guide/bifacial.rst b/docs/sphinx/source/user_guide/modeling_topics/bifacial.rst similarity index 100% rename from docs/sphinx/source/user_guide/bifacial.rst rename to docs/sphinx/source/user_guide/modeling_topics/bifacial.rst diff --git a/docs/sphinx/source/user_guide/clearsky.rst b/docs/sphinx/source/user_guide/modeling_topics/clearsky.rst similarity index 100% rename from docs/sphinx/source/user_guide/clearsky.rst rename to docs/sphinx/source/user_guide/modeling_topics/clearsky.rst diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/modeling_topics/index.rst similarity index 100% rename from docs/sphinx/source/user_guide/index.rst rename to docs/sphinx/source/user_guide/modeling_topics/index.rst diff --git a/docs/sphinx/source/user_guide/modelchain.rst b/docs/sphinx/source/user_guide/modeling_topics/modelchain.rst similarity index 100% rename from docs/sphinx/source/user_guide/modelchain.rst rename to docs/sphinx/source/user_guide/modeling_topics/modelchain.rst diff --git a/docs/sphinx/source/user_guide/pvsystem.rst b/docs/sphinx/source/user_guide/modeling_topics/pvsystem.rst similarity index 100% rename from docs/sphinx/source/user_guide/pvsystem.rst rename to docs/sphinx/source/user_guide/modeling_topics/pvsystem.rst diff --git a/docs/sphinx/source/user_guide/singlediode.rst b/docs/sphinx/source/user_guide/modeling_topics/singlediode.rst similarity index 100% rename from docs/sphinx/source/user_guide/singlediode.rst rename to docs/sphinx/source/user_guide/modeling_topics/singlediode.rst diff --git a/docs/sphinx/source/user_guide/timetimezones.rst b/docs/sphinx/source/user_guide/modeling_topics/timetimezones.rst similarity index 100% rename from docs/sphinx/source/user_guide/timetimezones.rst rename to docs/sphinx/source/user_guide/modeling_topics/timetimezones.rst diff --git a/docs/sphinx/source/user_guide/weather_data.rst b/docs/sphinx/source/user_guide/modeling_topics/weather_data.rst similarity index 100% rename from docs/sphinx/source/user_guide/weather_data.rst rename to docs/sphinx/source/user_guide/modeling_topics/weather_data.rst From f18d138ab54de5c43a6caa4448198a095c1925da Mon Sep 17 00:00:00 2001 From: RDaxini Date: Sun, 16 Mar 2025 15:52:38 -0600 Subject: [PATCH 02/19] index.rst file additions/modifications --- .../sphinx/source/user_guide/extras/index.rst | 11 ++++++ .../user_guide/getting_started/index.rst | 12 ++++++ .../getting_started/installation.rst | 2 +- docs/sphinx/source/user_guide/index.rst | 25 +++++++++++++ .../user_guide/modeling_topics/index.rst | 37 +++++-------------- 5 files changed, 58 insertions(+), 29 deletions(-) create mode 100644 docs/sphinx/source/user_guide/extras/index.rst create mode 100644 docs/sphinx/source/user_guide/getting_started/index.rst create mode 100644 docs/sphinx/source/user_guide/index.rst diff --git a/docs/sphinx/source/user_guide/extras/index.rst b/docs/sphinx/source/user_guide/extras/index.rst new file mode 100644 index 0000000000..9bca054fb5 --- /dev/null +++ b/docs/sphinx/source/user_guide/extras/index.rst @@ -0,0 +1,11 @@ +.. _user_guide_extras: + +Extras +====== + +.. toctree:: + :maxdepth: 1 + + nomenclature + faq + \ No newline at end of file diff --git a/docs/sphinx/source/user_guide/getting_started/index.rst b/docs/sphinx/source/user_guide/getting_started/index.rst new file mode 100644 index 0000000000..78795c9346 --- /dev/null +++ b/docs/sphinx/source/user_guide/getting_started/index.rst @@ -0,0 +1,12 @@ +.. _user_guide_getting_started: + +Getting Started +=============== + +.. toctree:: + :maxdepth: 1 + + package_overview + installation + introtutorial + \ No newline at end of file diff --git a/docs/sphinx/source/user_guide/getting_started/installation.rst b/docs/sphinx/source/user_guide/getting_started/installation.rst index aa766bf47e..c50fe0a37c 100644 --- a/docs/sphinx/source/user_guide/getting_started/installation.rst +++ b/docs/sphinx/source/user_guide/getting_started/installation.rst @@ -133,7 +133,7 @@ Follow these steps to obtain the library using git/GitHub: This button is circled in the image below. Remember the system path that you clone the library to. -.. image:: ../_images/clonebutton.png +.. image:: ../../_images/clonebutton.png Please see GitHub's `Forking Projects `_, diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst new file mode 100644 index 0000000000..cb3a72df4c --- /dev/null +++ b/docs/sphinx/source/user_guide/index.rst @@ -0,0 +1,25 @@ +.. _user_guide: + +========== +User Guide +========== + +This user guide is an overview and explains some of the key features of pvlib. + +.. toctree:: + :caption: Getting started + :maxdepth: 2 + + getting_started/index + +.. toctree:: + :caption: Modeling topics + :maxdepth: 2 + + modeling_topics/index + +.. toctree:: + :caption: Extras + :maxdepth: 2 + + extras/index \ No newline at end of file diff --git a/docs/sphinx/source/user_guide/modeling_topics/index.rst b/docs/sphinx/source/user_guide/modeling_topics/index.rst index 2241f9dffa..fc1900c732 100644 --- a/docs/sphinx/source/user_guide/modeling_topics/index.rst +++ b/docs/sphinx/source/user_guide/modeling_topics/index.rst @@ -1,34 +1,15 @@ -.. _user_guide: +.. _user_guide_modeling_topics: -========== -User Guide -========== +Modeling Topics +=============== -This user guide is an overview and explains some of the key features of pvlib. - -.. toctree:: - :caption: Getting started - :maxdepth: 2 - - package_overview - installation - introtutorial - .. toctree:: - :caption: Modeling topics - :maxdepth: 2 - - pvsystem - modelchain - timetimezones + :maxdepth: 1 + bifacial clearsky - weather_data + modelchain + pvsystem singlediode - -.. toctree:: - :caption: Extras - :maxdepth: 2 - - nomenclature - faq + timetimezones + weather_data From e2fece7511e63ce9b03e2274fb665019b9cb2ed5 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Sun, 16 Mar 2025 15:54:06 -0600 Subject: [PATCH 03/19] edit maxdepth --- docs/sphinx/source/user_guide/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index cb3a72df4c..b5727fc0d5 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -8,18 +8,18 @@ This user guide is an overview and explains some of the key features of pvlib. .. toctree:: :caption: Getting started - :maxdepth: 2 + :maxdepth: 1 getting_started/index .. toctree:: :caption: Modeling topics - :maxdepth: 2 + :maxdepth: 1 modeling_topics/index .. toctree:: :caption: Extras - :maxdepth: 2 + :maxdepth: 1 extras/index \ No newline at end of file From 906bbb0eb7ecb5dacd4b5eaa21577071755992cc Mon Sep 17 00:00:00 2001 From: RDaxini Date: Sun, 16 Mar 2025 16:05:20 -0600 Subject: [PATCH 04/19] userguide/index --- docs/sphinx/source/user_guide/index.rst | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index b5727fc0d5..f09119a188 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -7,19 +7,9 @@ User Guide This user guide is an overview and explains some of the key features of pvlib. .. toctree:: - :caption: Getting started - :maxdepth: 1 - + :maxdepth: 2 + :hidden: + getting_started/index - -.. toctree:: - :caption: Modeling topics - :maxdepth: 1 - modeling_topics/index - -.. toctree:: - :caption: Extras - :maxdepth: 1 - extras/index \ No newline at end of file From d3699a423149ba84502959ac6ae6eb53da4d4e4f Mon Sep 17 00:00:00 2001 From: RDaxini Date: Sun, 16 Mar 2025 16:42:26 -0600 Subject: [PATCH 05/19] Update index.rst --- docs/sphinx/source/user_guide/index.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index f09119a188..99d7af0ee5 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -8,8 +8,7 @@ This user guide is an overview and explains some of the key features of pvlib. .. toctree:: :maxdepth: 2 - :hidden: - + getting_started/index modeling_topics/index extras/index \ No newline at end of file From 34816cf12574851efc64ad12920b4be7d5d87f0b Mon Sep 17 00:00:00 2001 From: RDaxini Date: Sun, 16 Mar 2025 18:04:49 -0600 Subject: [PATCH 06/19] recover original rendering format --- .../sphinx/source/user_guide/extras/index.rst | 2 +- .../user_guide/getting_started/index.rst | 2 +- docs/sphinx/source/user_guide/index.rst | 30 +++++++++++++++---- .../user_guide/modeling_topics/index.rst | 2 +- 4 files changed, 28 insertions(+), 8 deletions(-) diff --git a/docs/sphinx/source/user_guide/extras/index.rst b/docs/sphinx/source/user_guide/extras/index.rst index 9bca054fb5..c49a101272 100644 --- a/docs/sphinx/source/user_guide/extras/index.rst +++ b/docs/sphinx/source/user_guide/extras/index.rst @@ -4,7 +4,7 @@ Extras ====== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 nomenclature faq diff --git a/docs/sphinx/source/user_guide/getting_started/index.rst b/docs/sphinx/source/user_guide/getting_started/index.rst index 78795c9346..0629e4fbc7 100644 --- a/docs/sphinx/source/user_guide/getting_started/index.rst +++ b/docs/sphinx/source/user_guide/getting_started/index.rst @@ -4,7 +4,7 @@ Getting Started =============== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 package_overview installation diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index 99d7af0ee5..dd3b014648 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -7,8 +7,28 @@ User Guide This user guide is an overview and explains some of the key features of pvlib. .. toctree:: - :maxdepth: 2 - - getting_started/index - modeling_topics/index - extras/index \ No newline at end of file + :caption: Getting started + :maxdepth: 1 + + getting_started/package_overview + getting_started/installation + getting_started/introtutorial + +.. toctree:: + :maxdepth: 1 + :caption: Getting started + + modeling_topics/pvsystem + modeling_topics/modelchain + modeling_topics/timetimezones + modeling_topics/bifacial + modeling_topics/clearsky + modeling_topics/weather_data + modeling_topics/singlediode + +.. toctree:: + :maxdepth: 1 + :caption: Getting started + + extras/nomenclature + extras/faq diff --git a/docs/sphinx/source/user_guide/modeling_topics/index.rst b/docs/sphinx/source/user_guide/modeling_topics/index.rst index fc1900c732..797cd92074 100644 --- a/docs/sphinx/source/user_guide/modeling_topics/index.rst +++ b/docs/sphinx/source/user_guide/modeling_topics/index.rst @@ -4,7 +4,7 @@ Modeling Topics =============== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 bifacial clearsky From ebe16554c8334d69a9292df66a9f61780875ef45 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Sun, 16 Mar 2025 18:41:33 -0600 Subject: [PATCH 07/19] change max depth --- docs/sphinx/source/user_guide/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index dd3b014648..9f71d27aae 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -8,14 +8,14 @@ This user guide is an overview and explains some of the key features of pvlib. .. toctree:: :caption: Getting started - :maxdepth: 1 + :maxdepth: 2 getting_started/package_overview getting_started/installation getting_started/introtutorial .. toctree:: - :maxdepth: 1 + :maxdepth: 2 :caption: Getting started modeling_topics/pvsystem @@ -27,7 +27,7 @@ This user guide is an overview and explains some of the key features of pvlib. modeling_topics/singlediode .. toctree:: - :maxdepth: 1 + :maxdepth: 2 :caption: Getting started extras/nomenclature From 7a311a288c61c8154bc4abd916968abea1d01631 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Wed, 19 Mar 2025 09:25:24 -0600 Subject: [PATCH 08/19] Update index.rst --- docs/sphinx/source/user_guide/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index 9f71d27aae..77ad210d03 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -16,7 +16,7 @@ This user guide is an overview and explains some of the key features of pvlib. .. toctree:: :maxdepth: 2 - :caption: Getting started + :caption: Modeling topics modeling_topics/pvsystem modeling_topics/modelchain @@ -28,7 +28,7 @@ This user guide is an overview and explains some of the key features of pvlib. .. toctree:: :maxdepth: 2 - :caption: Getting started + :caption: Extras extras/nomenclature extras/faq From 6e62bd88823fb2e32306fe0ffb77957f9f0a110f Mon Sep 17 00:00:00 2001 From: RDaxini Date: Wed, 19 Mar 2025 10:52:10 -0600 Subject: [PATCH 09/19] refer to subsecton index in main index --- docs/sphinx/source/user_guide/index.rst | 15 +++------------ 1 file changed, 3 insertions(+), 12 deletions(-) diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index 77ad210d03..7893619388 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -10,25 +10,16 @@ This user guide is an overview and explains some of the key features of pvlib. :caption: Getting started :maxdepth: 2 - getting_started/package_overview - getting_started/installation - getting_started/introtutorial + getting_started/index .. toctree:: :maxdepth: 2 :caption: Modeling topics - modeling_topics/pvsystem - modeling_topics/modelchain - modeling_topics/timetimezones - modeling_topics/bifacial - modeling_topics/clearsky - modeling_topics/weather_data - modeling_topics/singlediode + modeling_topics/index .. toctree:: :maxdepth: 2 :caption: Extras - extras/nomenclature - extras/faq + extras/index From d57c391d851dcba580caa0e87c8602b6d190c5bc Mon Sep 17 00:00:00 2001 From: RDaxini Date: Wed, 19 Mar 2025 11:06:07 -0600 Subject: [PATCH 10/19] remove extra spaces --- docs/sphinx/source/user_guide/extras/index.rst | 1 - docs/sphinx/source/user_guide/getting_started/index.rst | 1 - docs/sphinx/source/user_guide/index.rst | 2 +- 3 files changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/sphinx/source/user_guide/extras/index.rst b/docs/sphinx/source/user_guide/extras/index.rst index c49a101272..bd8b865cbd 100644 --- a/docs/sphinx/source/user_guide/extras/index.rst +++ b/docs/sphinx/source/user_guide/extras/index.rst @@ -8,4 +8,3 @@ Extras nomenclature faq - \ No newline at end of file diff --git a/docs/sphinx/source/user_guide/getting_started/index.rst b/docs/sphinx/source/user_guide/getting_started/index.rst index 0629e4fbc7..8674c8cb65 100644 --- a/docs/sphinx/source/user_guide/getting_started/index.rst +++ b/docs/sphinx/source/user_guide/getting_started/index.rst @@ -9,4 +9,3 @@ Getting Started package_overview installation introtutorial - \ No newline at end of file diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index 7893619388..e633e0a6cd 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -16,7 +16,7 @@ This user guide is an overview and explains some of the key features of pvlib. :maxdepth: 2 :caption: Modeling topics - modeling_topics/index + modeling_topics/index .. toctree:: :maxdepth: 2 From 3dc9819656bdb541d35ba7ba11f22c034136bace Mon Sep 17 00:00:00 2001 From: RDaxini Date: Wed, 19 Mar 2025 11:42:37 -0600 Subject: [PATCH 11/19] try hidden? --- docs/sphinx/source/user_guide/index.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index e633e0a6cd..db68779e8b 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -9,17 +9,20 @@ This user guide is an overview and explains some of the key features of pvlib. .. toctree:: :caption: Getting started :maxdepth: 2 + :hidden: getting_started/index .. toctree:: :maxdepth: 2 :caption: Modeling topics + :hidden: modeling_topics/index .. toctree:: :maxdepth: 2 :caption: Extras + :hidden: extras/index From 5de862f468a0bf97e05e665520ba4d1258c3a76b Mon Sep 17 00:00:00 2001 From: RDaxini Date: Wed, 19 Mar 2025 11:51:16 -0600 Subject: [PATCH 12/19] Revert "try hidden?" This reverts commit 3dc9819656bdb541d35ba7ba11f22c034136bace. --- docs/sphinx/source/user_guide/index.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index db68779e8b..e633e0a6cd 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -9,20 +9,17 @@ This user guide is an overview and explains some of the key features of pvlib. .. toctree:: :caption: Getting started :maxdepth: 2 - :hidden: getting_started/index .. toctree:: :maxdepth: 2 :caption: Modeling topics - :hidden: modeling_topics/index .. toctree:: :maxdepth: 2 :caption: Extras - :hidden: extras/index From 33054c90ff40786d7b02ea15dd698d359d15a460 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Wed, 19 Mar 2025 11:51:26 -0600 Subject: [PATCH 13/19] Revert "remove extra spaces" This reverts commit d57c391d851dcba580caa0e87c8602b6d190c5bc. --- docs/sphinx/source/user_guide/extras/index.rst | 1 + docs/sphinx/source/user_guide/getting_started/index.rst | 1 + docs/sphinx/source/user_guide/index.rst | 2 +- 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/sphinx/source/user_guide/extras/index.rst b/docs/sphinx/source/user_guide/extras/index.rst index bd8b865cbd..c49a101272 100644 --- a/docs/sphinx/source/user_guide/extras/index.rst +++ b/docs/sphinx/source/user_guide/extras/index.rst @@ -8,3 +8,4 @@ Extras nomenclature faq + \ No newline at end of file diff --git a/docs/sphinx/source/user_guide/getting_started/index.rst b/docs/sphinx/source/user_guide/getting_started/index.rst index 8674c8cb65..0629e4fbc7 100644 --- a/docs/sphinx/source/user_guide/getting_started/index.rst +++ b/docs/sphinx/source/user_guide/getting_started/index.rst @@ -9,3 +9,4 @@ Getting Started package_overview installation introtutorial + \ No newline at end of file diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index e633e0a6cd..7893619388 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -16,7 +16,7 @@ This user guide is an overview and explains some of the key features of pvlib. :maxdepth: 2 :caption: Modeling topics - modeling_topics/index + modeling_topics/index .. toctree:: :maxdepth: 2 From 572fac67f57b482460dd8d788dd7029fa8a83b87 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Wed, 19 Mar 2025 11:51:33 -0600 Subject: [PATCH 14/19] Revert "refer to subsecton index in main index" This reverts commit 6e62bd88823fb2e32306fe0ffb77957f9f0a110f. --- docs/sphinx/source/user_guide/index.rst | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index 7893619388..77ad210d03 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -10,16 +10,25 @@ This user guide is an overview and explains some of the key features of pvlib. :caption: Getting started :maxdepth: 2 - getting_started/index + getting_started/package_overview + getting_started/installation + getting_started/introtutorial .. toctree:: :maxdepth: 2 :caption: Modeling topics - modeling_topics/index + modeling_topics/pvsystem + modeling_topics/modelchain + modeling_topics/timetimezones + modeling_topics/bifacial + modeling_topics/clearsky + modeling_topics/weather_data + modeling_topics/singlediode .. toctree:: :maxdepth: 2 :caption: Extras - extras/index + extras/nomenclature + extras/faq From 9c4ecbcde47bd751feb1731063e0b27bf8353bf6 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Wed, 19 Mar 2025 14:48:50 -0600 Subject: [PATCH 15/19] remove spaces --- docs/sphinx/source/user_guide/extras/index.rst | 1 - docs/sphinx/source/user_guide/getting_started/index.rst | 1 - 2 files changed, 2 deletions(-) diff --git a/docs/sphinx/source/user_guide/extras/index.rst b/docs/sphinx/source/user_guide/extras/index.rst index c49a101272..bd8b865cbd 100644 --- a/docs/sphinx/source/user_guide/extras/index.rst +++ b/docs/sphinx/source/user_guide/extras/index.rst @@ -8,4 +8,3 @@ Extras nomenclature faq - \ No newline at end of file diff --git a/docs/sphinx/source/user_guide/getting_started/index.rst b/docs/sphinx/source/user_guide/getting_started/index.rst index 0629e4fbc7..8674c8cb65 100644 --- a/docs/sphinx/source/user_guide/getting_started/index.rst +++ b/docs/sphinx/source/user_guide/getting_started/index.rst @@ -9,4 +9,3 @@ Getting Started package_overview installation introtutorial - \ No newline at end of file From 029a11e18388471eacfadee825b37e7859b45e2a Mon Sep 17 00:00:00 2001 From: RDaxini Date: Wed, 19 Mar 2025 14:56:11 -0600 Subject: [PATCH 16/19] match subsection order --- .../source/user_guide/modeling_topics/index.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/sphinx/source/user_guide/modeling_topics/index.rst b/docs/sphinx/source/user_guide/modeling_topics/index.rst index 797cd92074..059da3062c 100644 --- a/docs/sphinx/source/user_guide/modeling_topics/index.rst +++ b/docs/sphinx/source/user_guide/modeling_topics/index.rst @@ -6,10 +6,10 @@ Modeling Topics .. toctree:: :maxdepth: 2 - bifacial - clearsky - modelchain - pvsystem - singlediode - timetimezones - weather_data + pvsystem + modelchain + timetimezones + bifacial + clearsky + weather_data + singlediode From 9764b08a1beb3712d5b38c842e1e7ea942b87fe2 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Wed, 19 Mar 2025 15:27:55 -0600 Subject: [PATCH 17/19] more extra spaces --- .../source/user_guide/modeling_topics/index.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/sphinx/source/user_guide/modeling_topics/index.rst b/docs/sphinx/source/user_guide/modeling_topics/index.rst index 059da3062c..0197d96740 100644 --- a/docs/sphinx/source/user_guide/modeling_topics/index.rst +++ b/docs/sphinx/source/user_guide/modeling_topics/index.rst @@ -6,10 +6,10 @@ Modeling Topics .. toctree:: :maxdepth: 2 - pvsystem - modelchain - timetimezones - bifacial - clearsky - weather_data - singlediode + pvsystem + modelchain + timetimezones + bifacial + clearsky + weather_data + singlediode From a40afa6f50fa4977857685df9a98ffe38566423b Mon Sep 17 00:00:00 2001 From: RDaxini Date: Thu, 20 Mar 2025 12:58:18 -0600 Subject: [PATCH 18/19] Revert "more extra spaces" This reverts commit 9764b08a1beb3712d5b38c842e1e7ea942b87fe2. --- .../source/user_guide/modeling_topics/index.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/sphinx/source/user_guide/modeling_topics/index.rst b/docs/sphinx/source/user_guide/modeling_topics/index.rst index 0197d96740..059da3062c 100644 --- a/docs/sphinx/source/user_guide/modeling_topics/index.rst +++ b/docs/sphinx/source/user_guide/modeling_topics/index.rst @@ -6,10 +6,10 @@ Modeling Topics .. toctree:: :maxdepth: 2 - pvsystem - modelchain - timetimezones - bifacial - clearsky - weather_data - singlediode + pvsystem + modelchain + timetimezones + bifacial + clearsky + weather_data + singlediode From 552728ff907a7dee285861075c18e6726759162f Mon Sep 17 00:00:00 2001 From: RDaxini Date: Thu, 10 Apr 2025 09:18:42 -0600 Subject: [PATCH 19/19] remove sublevel index.rst --- docs/sphinx/source/user_guide/extras/index.rst | 10 ---------- .../source/user_guide/getting_started/index.rst | 11 ----------- .../source/user_guide/modeling_topics/index.rst | 15 --------------- 3 files changed, 36 deletions(-) delete mode 100644 docs/sphinx/source/user_guide/extras/index.rst delete mode 100644 docs/sphinx/source/user_guide/getting_started/index.rst delete mode 100644 docs/sphinx/source/user_guide/modeling_topics/index.rst diff --git a/docs/sphinx/source/user_guide/extras/index.rst b/docs/sphinx/source/user_guide/extras/index.rst deleted file mode 100644 index bd8b865cbd..0000000000 --- a/docs/sphinx/source/user_guide/extras/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _user_guide_extras: - -Extras -====== - -.. toctree:: - :maxdepth: 2 - - nomenclature - faq diff --git a/docs/sphinx/source/user_guide/getting_started/index.rst b/docs/sphinx/source/user_guide/getting_started/index.rst deleted file mode 100644 index 8674c8cb65..0000000000 --- a/docs/sphinx/source/user_guide/getting_started/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _user_guide_getting_started: - -Getting Started -=============== - -.. toctree:: - :maxdepth: 2 - - package_overview - installation - introtutorial diff --git a/docs/sphinx/source/user_guide/modeling_topics/index.rst b/docs/sphinx/source/user_guide/modeling_topics/index.rst deleted file mode 100644 index 059da3062c..0000000000 --- a/docs/sphinx/source/user_guide/modeling_topics/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _user_guide_modeling_topics: - -Modeling Topics -=============== - -.. toctree:: - :maxdepth: 2 - - pvsystem - modelchain - timetimezones - bifacial - clearsky - weather_data - singlediode