From 41673c93942beba94f598110d6969efb7e7cad8c Mon Sep 17 00:00:00 2001 From: RDaxini Date: Tue, 26 Nov 2024 15:13:02 -0700 Subject: [PATCH 01/12] initial creation --- docs/sphinx/source/index.rst | 1 + .../source/{user_guide => learning}/bifacial.rst | 0 .../source/{user_guide => learning}/clearsky.rst | 0 docs/sphinx/source/learning/index.rst | 16 ++++++++++++++++ .../{user_guide => learning}/introtutorial.rst | 0 .../{user_guide => learning}/modelchain.rst | 0 .../{user_guide => learning}/nomenclature.rst | 0 .../source/{user_guide => learning}/pvsystem.rst | 0 .../{user_guide => learning}/singlediode.rst | 0 .../{user_guide => learning}/timetimezones.rst | 0 .../{user_guide => learning}/weather_data.rst | 0 docs/sphinx/source/user_guide/index.rst | 8 -------- 12 files changed, 17 insertions(+), 8 deletions(-) rename docs/sphinx/source/{user_guide => learning}/bifacial.rst (100%) rename docs/sphinx/source/{user_guide => learning}/clearsky.rst (100%) create mode 100644 docs/sphinx/source/learning/index.rst rename docs/sphinx/source/{user_guide => learning}/introtutorial.rst (100%) rename docs/sphinx/source/{user_guide => learning}/modelchain.rst (100%) rename docs/sphinx/source/{user_guide => learning}/nomenclature.rst (100%) rename docs/sphinx/source/{user_guide => learning}/pvsystem.rst (100%) rename docs/sphinx/source/{user_guide => learning}/singlediode.rst (100%) rename docs/sphinx/source/{user_guide => learning}/timetimezones.rst (100%) rename docs/sphinx/source/{user_guide => learning}/weather_data.rst (100%) diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 20e776bf2f..4272c889e6 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -139,5 +139,6 @@ pvlib python is a `NumFOCUS Affiliated Project Date: Tue, 26 Nov 2024 15:34:07 -0700 Subject: [PATCH 02/12] return glossary to user guide --- docs/sphinx/source/{learning => user_guide}/nomenclature.rst | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/sphinx/source/{learning => user_guide}/nomenclature.rst (100%) diff --git a/docs/sphinx/source/learning/nomenclature.rst b/docs/sphinx/source/user_guide/nomenclature.rst similarity index 100% rename from docs/sphinx/source/learning/nomenclature.rst rename to docs/sphinx/source/user_guide/nomenclature.rst From d360736bbf3f756f237dd68bf71d58306d1be6b5 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Mon, 23 Dec 2024 10:34:54 -0700 Subject: [PATCH 03/12] revert learning page --- .../source/{learning => user_guide}/bifacial.rst | 0 .../source/{learning => user_guide}/clearsky.rst | 0 docs/sphinx/source/user_guide/index.rst | 10 +++++++++- .../source/{learning => user_guide}/introtutorial.rst | 0 .../source/{learning => user_guide}/modelchain.rst | 0 .../source/{learning => user_guide}/pvsystem.rst | 0 .../source/{learning => user_guide}/singlediode.rst | 0 .../source/{learning => user_guide}/timetimezones.rst | 0 .../source/{learning => user_guide}/weather_data.rst | 0 9 files changed, 9 insertions(+), 1 deletion(-) rename docs/sphinx/source/{learning => user_guide}/bifacial.rst (100%) rename docs/sphinx/source/{learning => user_guide}/clearsky.rst (100%) rename docs/sphinx/source/{learning => user_guide}/introtutorial.rst (100%) rename docs/sphinx/source/{learning => user_guide}/modelchain.rst (100%) rename docs/sphinx/source/{learning => user_guide}/pvsystem.rst (100%) rename docs/sphinx/source/{learning => user_guide}/singlediode.rst (100%) rename docs/sphinx/source/{learning => user_guide}/timetimezones.rst (100%) rename docs/sphinx/source/{learning => user_guide}/weather_data.rst (100%) diff --git a/docs/sphinx/source/learning/bifacial.rst b/docs/sphinx/source/user_guide/bifacial.rst similarity index 100% rename from docs/sphinx/source/learning/bifacial.rst rename to docs/sphinx/source/user_guide/bifacial.rst diff --git a/docs/sphinx/source/learning/clearsky.rst b/docs/sphinx/source/user_guide/clearsky.rst similarity index 100% rename from docs/sphinx/source/learning/clearsky.rst rename to docs/sphinx/source/user_guide/clearsky.rst diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index c37a638fbf..aa4939c0c5 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -8,5 +8,13 @@ User Guide package_overview installation + introtutorial + pvsystem + modelchain + timetimezones + clearsky + bifacial + weather_data + singlediode nomenclature - faq + faq \ No newline at end of file diff --git a/docs/sphinx/source/learning/introtutorial.rst b/docs/sphinx/source/user_guide/introtutorial.rst similarity index 100% rename from docs/sphinx/source/learning/introtutorial.rst rename to docs/sphinx/source/user_guide/introtutorial.rst diff --git a/docs/sphinx/source/learning/modelchain.rst b/docs/sphinx/source/user_guide/modelchain.rst similarity index 100% rename from docs/sphinx/source/learning/modelchain.rst rename to docs/sphinx/source/user_guide/modelchain.rst diff --git a/docs/sphinx/source/learning/pvsystem.rst b/docs/sphinx/source/user_guide/pvsystem.rst similarity index 100% rename from docs/sphinx/source/learning/pvsystem.rst rename to docs/sphinx/source/user_guide/pvsystem.rst diff --git a/docs/sphinx/source/learning/singlediode.rst b/docs/sphinx/source/user_guide/singlediode.rst similarity index 100% rename from docs/sphinx/source/learning/singlediode.rst rename to docs/sphinx/source/user_guide/singlediode.rst diff --git a/docs/sphinx/source/learning/timetimezones.rst b/docs/sphinx/source/user_guide/timetimezones.rst similarity index 100% rename from docs/sphinx/source/learning/timetimezones.rst rename to docs/sphinx/source/user_guide/timetimezones.rst diff --git a/docs/sphinx/source/learning/weather_data.rst b/docs/sphinx/source/user_guide/weather_data.rst similarity index 100% rename from docs/sphinx/source/learning/weather_data.rst rename to docs/sphinx/source/user_guide/weather_data.rst From c325fdd86fa6a1388903a1a1b7e618438aef0d58 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Mon, 23 Dec 2024 10:35:40 -0700 Subject: [PATCH 04/12] add section label to index.rst --- docs/sphinx/source/user_guide/index.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index aa4939c0c5..94f5503b05 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -1,3 +1,5 @@ +.. _user_guide: + ========== User Guide ========== From eea19923314554f384da7ee59caa2fa97dbce8b6 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Mon, 23 Dec 2024 10:36:51 -0700 Subject: [PATCH 05/12] delete learning --- docs/sphinx/source/learning/index.rst | 16 ---------------- 1 file changed, 16 deletions(-) delete mode 100644 docs/sphinx/source/learning/index.rst diff --git a/docs/sphinx/source/learning/index.rst b/docs/sphinx/source/learning/index.rst deleted file mode 100644 index 984d6d3c5e..0000000000 --- a/docs/sphinx/source/learning/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -======== -Learning -======== - - -.. toctree:: - :maxdepth: 2 - - introtutorial - pvsystem - modelchain - timetimezones - clearsky - bifacial - weather_data - singlediode From cd79f75fab81ac1fb1c6a499a72ee4c8f74a65bf Mon Sep 17 00:00:00 2001 From: RDaxini Date: Mon, 23 Dec 2024 10:40:25 -0700 Subject: [PATCH 06/12] Update index.rst --- docs/sphinx/source/user_guide/index.rst | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index 94f5503b05..94954f4965 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -4,19 +4,31 @@ User Guide ========== +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: Advanced usage + :maxdepth: 2 + pvsystem modelchain timetimezones - clearsky bifacial + clearsky weather_data singlediode + +.. toctree:: + :caption: Extras + :maxdepth: 1 + nomenclature - faq \ No newline at end of file + faq From 3f48b793a69bfce5db75460d017f3a445a22b6a2 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Mon, 23 Dec 2024 10:45:50 -0700 Subject: [PATCH 07/12] update extras maxdepth in index.rst --- docs/sphinx/source/user_guide/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index 94954f4965..b75654d5a5 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -28,7 +28,7 @@ This user guide is an overview and explains some of the key features of pvlib. .. toctree:: :caption: Extras - :maxdepth: 1 + :maxdepth: 2 nomenclature faq From bf15b7441fe1e7be637a163765ee8560ed8d82e5 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Mon, 23 Dec 2024 10:49:46 -0700 Subject: [PATCH 08/12] user guide label test --- docs/sphinx/source/index.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 4272c889e6..cff0964d56 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -14,6 +14,9 @@ The source code for pvlib python is hosted on `GitHub `_. Please see the :ref:`installation` page for installation help. + +Test :ref:`user_guide` + For examples of how to use pvlib python, please see :ref:`package_overview` and the :ref:`example_gallery`. The documentation assumes general familiarity with From 9a7aa0a891561f3435629f08e878b5af134b44fb Mon Sep 17 00:00:00 2001 From: RDaxini Date: Mon, 23 Dec 2024 11:12:28 -0700 Subject: [PATCH 09/12] remove user guide label test (passed) --- docs/sphinx/source/index.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index cff0964d56..4272c889e6 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -14,9 +14,6 @@ The source code for pvlib python is hosted on `GitHub `_. Please see the :ref:`installation` page for installation help. - -Test :ref:`user_guide` - For examples of how to use pvlib python, please see :ref:`package_overview` and the :ref:`example_gallery`. The documentation assumes general familiarity with From 66ea0f419c45ae27feaf6314f97b5146ca3fb09a Mon Sep 17 00:00:00 2001 From: RDaxini Date: Mon, 23 Dec 2024 11:40:12 -0700 Subject: [PATCH 10/12] remove learning from index --- docs/sphinx/source/index.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 4272c889e6..20e776bf2f 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -139,6 +139,5 @@ pvlib python is a `NumFOCUS Affiliated Project Date: Tue, 24 Dec 2024 09:14:31 -0700 Subject: [PATCH 11/12] change subsection title -> modeling topcis Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com> --- docs/sphinx/source/user_guide/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index b75654d5a5..2241f9dffa 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -15,7 +15,7 @@ This user guide is an overview and explains some of the key features of pvlib. introtutorial .. toctree:: - :caption: Advanced usage + :caption: Modeling topics :maxdepth: 2 pvsystem From 56d9c96fac42fdcb8f1f727f2010f1b16121d294 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Tue, 24 Dec 2024 09:22:27 -0700 Subject: [PATCH 12/12] Update v0.11.3.rst --- docs/sphinx/source/whatsnew/v0.11.3.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/sphinx/source/whatsnew/v0.11.3.rst b/docs/sphinx/source/whatsnew/v0.11.3.rst index 238ec1e9a6..4b0582c712 100644 --- a/docs/sphinx/source/whatsnew/v0.11.3.rst +++ b/docs/sphinx/source/whatsnew/v0.11.3.rst @@ -14,6 +14,7 @@ Enhancements Documentation ~~~~~~~~~~~~~ +* Restructure the user guide with subsections (:issue:`2302`, :pull:`2310`) Testing @@ -26,5 +27,6 @@ Requirements Contributors ~~~~~~~~~~~~ +* Rajiv Daxini (:ghuser:`RDaxini`)