From ad7be77f30dd9892d38877d44cfd3e35be28c734 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Wed, 29 Dec 2021 14:03:41 -0500 Subject: [PATCH 1/8] clean up internal links --- docs/tutorials/irradiance.ipynb | 2 +- pvlib/iotools/midc.py | 4 ++-- pvlib/modelchain.py | 3 +-- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/tutorials/irradiance.ipynb b/docs/tutorials/irradiance.ipynb index 5b1b9a82b6..39409c187f 100644 --- a/docs/tutorials/irradiance.ipynb +++ b/docs/tutorials/irradiance.ipynb @@ -367,7 +367,7 @@ "source": [ "See the online documentation for clear sky modeling examples.\n", "\n", - "http://pvlib-python.readthedocs.io/en/latest/clearsky.html\n", + "http://pvlib-python.readthedocs.io/en/stable/user_guide/clearsky.html\n", "\n", "Here we only generate data for the functions below." ] diff --git a/pvlib/iotools/midc.py b/pvlib/iotools/midc.py index c113d87bca..063326b60c 100644 --- a/pvlib/iotools/midc.py +++ b/pvlib/iotools/midc.py @@ -187,8 +187,8 @@ def read_midc(filename, variable_map={}, raw_data=False, **kwargs): {'Global Horizontal [W/m^2]': 'ghi'} See the MIDC_VARIABLE_MAP for collection of mappings by site. - For a full list of pvlib variable names see the `Variable Style Rules - `_. + For a full list of pvlib variable names see the + :ref:`variables_style_rules`. Be sure to check the units for the variables you will use on the `MIDC site `_. diff --git a/pvlib/modelchain.py b/pvlib/modelchain.py index eb0db817fd..e97a593ea6 100644 --- a/pvlib/modelchain.py +++ b/pvlib/modelchain.py @@ -382,8 +382,7 @@ class ModelChain: appropriate model parameters. For example, if ``dc_model='pvwatts'``, then each ``Array.module_parameters`` must contain ``'pdc0'``. - See https://pvlib-python.readthedocs.io/en/stable/modelchain.html - for examples. + See :ref:`modelchaindoc` for examples. Parameters ---------- From 51b1ae9664d391e96fb3fbe8a4b2176b5169efdd Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Wed, 29 Dec 2021 14:27:12 -0500 Subject: [PATCH 2/8] fix the pvlib-maintainer tagging instructions --- docs/sphinx/source/contributing.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/contributing.rst b/docs/sphinx/source/contributing.rst index f5182a29d3..3106716c11 100644 --- a/docs/sphinx/source/contributing.rst +++ b/docs/sphinx/source/contributing.rst @@ -150,13 +150,14 @@ a timely manner is to: #. Start by creating an issue. The issue should be well-defined and actionable. -#. Ask the maintainers to tag the issue with the appropriate milestone. +#. Ask the [maintainers](https://github.com/orgs/pvlib/people) to tag + the issue with the appropriate milestone. #. Make a limited-scope pull request. It can be a lot of work to check all of the boxes in `pull request guidelines `_, especially for pull requests with a lot of new primary code. See :ref:`pull-request-scope`. -#. Tag pvlib community members or ``@pvlib/maintainer`` when the pull +#. Tag pvlib community members or ``@pvlib/pvlib-maintainer`` when the pull request is ready for review. (see :ref:`pull-request-reviews`) From 20c1447ec0b4b7d3df9166d2fb48c20e2769cfeb Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Sun, 23 Jan 2022 10:35:43 -0500 Subject: [PATCH 3/8] clean up surfrad.py --- pvlib/iotools/surfrad.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pvlib/iotools/surfrad.py b/pvlib/iotools/surfrad.py index c82b7fb22b..b819923497 100644 --- a/pvlib/iotools/surfrad.py +++ b/pvlib/iotools/surfrad.py @@ -47,7 +47,7 @@ def read_surfrad(filename, map_variables=True): Filepath or url. map_variables: bool When true, renames columns of the Dataframe to pvlib variable names - where applicable. See variable SURFRAD_COLUMNS. + where applicable. See variable :const:`VARIABLE_MAP`. Returns ------- @@ -113,7 +113,7 @@ def read_surfrad(filename, map_variables=True): ======================= ====== ========================================== See README files located in the station directories in the SURFRAD - data archives[2]_ for details on SURFRAD daily data files. + data archives [2]_ for details on SURFRAD daily data files. References ---------- From 8742156aada1d9df7bfbce1b7a152b41d76943ff Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Sun, 23 Jan 2022 10:36:12 -0500 Subject: [PATCH 4/8] update ad location for new theme version --- docs/sphinx/source/conf.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 32314eb1a8..9826781d6d 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -159,6 +159,7 @@ "use_edit_page_button": True, "show_toc_level": 1, "footer_items": ["copyright", "sphinx-version", "sidebar-ethical-ads"], + "left_sidebar_end": [], } # Add any paths that contain custom themes here, relative to this directory. @@ -199,9 +200,7 @@ #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -html_sidebars = { - "**": ["search-field", "sidebar-nav-bs"] # "sidebar-ethical-ads" -} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. From ddc05ed6ad6c5f71e7404f6455c180d5d215e794 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Sun, 23 Jan 2022 10:36:17 -0500 Subject: [PATCH 5/8] pin theme version --- setup.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/setup.py b/setup.py index b2cbf486d5..6e7652c44f 100755 --- a/setup.py +++ b/setup.py @@ -57,8 +57,8 @@ 'pvfactors', 'siphon', 'statsmodels', 'cftime >= 1.1.1'], 'doc': ['ipython', 'matplotlib', 'sphinx == 3.1.2', - 'pydata-sphinx-theme', 'sphinx-gallery', 'docutils == 0.15.2', - 'pillow', 'netcdf4', 'siphon', + 'pydata-sphinx-theme == 0.8.0', 'sphinx-gallery', + 'docutils == 0.15.2', 'pillow', 'netcdf4', 'siphon', 'sphinx-toggleprompt >= 0.0.5'], 'test': TESTS_REQUIRE } From a9bd4e111f808ce6a058f9828e5a251ea71d427e Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Sun, 23 Jan 2022 10:55:22 -0500 Subject: [PATCH 6/8] update broken wfcsv.pdf links --- pvlib/iotools/psm3.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pvlib/iotools/psm3.py b/pvlib/iotools/psm3.py index 44fba674b1..eac16eb0b5 100644 --- a/pvlib/iotools/psm3.py +++ b/pvlib/iotools/psm3.py @@ -262,7 +262,7 @@ def parse_psm3(fbuf): .. [1] `NREL National Solar Radiation Database (NSRDB) `_ .. [2] `Standard Time Series Data File Format - `_ + `_ """ # The first 2 lines of the response are headers with metadata metadata_fields = fbuf.readline().split(',') @@ -331,7 +331,7 @@ def read_psm3(filename): .. [1] `NREL National Solar Radiation Database (NSRDB) `_ .. [2] `Standard Time Series Data File Format - `_ + `_ """ with open(str(filename), 'r') as fbuf: content = parse_psm3(fbuf) From 2862b8175bf34f981ff2aa7b90c2632b274807cb Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Sun, 23 Jan 2022 11:30:01 -0500 Subject: [PATCH 7/8] switch to just tagging pvlib, not the untaggable pvlib-maintainer team --- docs/sphinx/source/contributing.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/contributing.rst b/docs/sphinx/source/contributing.rst index 3106716c11..2f15e6eed7 100644 --- a/docs/sphinx/source/contributing.rst +++ b/docs/sphinx/source/contributing.rst @@ -157,7 +157,7 @@ a timely manner is to: `_, especially for pull requests with a lot of new primary code. See :ref:`pull-request-scope`. -#. Tag pvlib community members or ``@pvlib/pvlib-maintainer`` when the pull +#. Tag pvlib community members or ``@pvlib`` when the pull request is ready for review. (see :ref:`pull-request-reviews`) @@ -167,7 +167,7 @@ Pull request reviews -------------------- The pvlib community and maintainers will review your pull request in a -timely fashion. Please "ping" ``@pvlib/maintainer`` if it seems that +timely fashion. Please "ping" ``@pvlib`` if it seems that your pull request has been forgotten at any point in the pull request process. From 0e0d82dec0e9837180a16bfa6b191a5871adeb03 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Sun, 23 Jan 2022 11:44:01 -0500 Subject: [PATCH 8/8] fix silly md/rst confusion --- docs/sphinx/source/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/contributing.rst b/docs/sphinx/source/contributing.rst index 2f15e6eed7..3e224f6abd 100644 --- a/docs/sphinx/source/contributing.rst +++ b/docs/sphinx/source/contributing.rst @@ -150,7 +150,7 @@ a timely manner is to: #. Start by creating an issue. The issue should be well-defined and actionable. -#. Ask the [maintainers](https://github.com/orgs/pvlib/people) to tag +#. Ask the `maintainers `_ to tag the issue with the appropriate milestone. #. Make a limited-scope pull request. It can be a lot of work to check all of the boxes in `pull request guidelines