diff --git a/README.md b/README.md index 38496b88d1..c59c44e085 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ reliable, interoperable, and benchmark implementations of PV system models. Documentation ============= -Full documentation can be found at [readthedocs](http://pvlib-python.readthedocs.io/en/stable/), +Full documentation can be found at [readthedocs](https://pvlib-python.readthedocs.io/en/stable/), including an [FAQ](https://pvlib-python.readthedocs.io/en/stable/user_guide/extras/faq.html) page. Installation diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 90c2f0a3a5..b807883158 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -160,7 +160,7 @@ # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -# https://pydata-sphinx-theme.rtfd.io/en/latest/user_guide/configuring.html +# https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/layout.html html_theme_options = { "github_url": "https://github.com/pvlib/pvlib-python", "icon_links": [ diff --git a/docs/sphinx/source/contributing/style_guide.rst b/docs/sphinx/source/contributing/style_guide.rst index be329e64e7..8dce0a0544 100644 --- a/docs/sphinx/source/contributing/style_guide.rst +++ b/docs/sphinx/source/contributing/style_guide.rst @@ -301,9 +301,9 @@ required for every function. .. [1] Anderson, K., Hansen, C., Holmgren, W., Jensen, A., Mikofski, M., and Driesse, A. "pvlib python: 2023 project update." Journal of Open Source Software, 8(92), 5994, (2023). :doi:`10.21105/joss.05994`. - .. [2] J. Smith and J. Doe. "Obama inaugurated as President." CNN.com. - Accessed: Feb. 1, 2009. [Online.] - Available: http://www.cnn.com/POLITICS/01/21/obama_inaugurated/index.html + .. [2] "PVPMC Home." Sandia National Laboratories PV Performance Modeling + Collaborative. Accessed: Oct. 17, 2024. [Online.] + Available: https://pvpmc.sandia.gov/ """ a = "Some" b = "thing" diff --git a/docs/sphinx/source/user_guide/getting_started/installation.rst b/docs/sphinx/source/user_guide/getting_started/installation.rst index cbeb3b0d03..4bfe748ab7 100644 --- a/docs/sphinx/source/user_guide/getting_started/installation.rst +++ b/docs/sphinx/source/user_guide/getting_started/installation.rst @@ -147,8 +147,7 @@ Set up a virtual environment ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ We strongly recommend working in a `virtual environment -`_ if you're going to use an editable version +`_ if you're going to use an editable version of the library. You can skip this step if: #. You already have Anaconda or another scientific Python distribution diff --git a/docs/sphinx/source/user_guide/modeling_topics/spectrum.rst b/docs/sphinx/source/user_guide/modeling_topics/spectrum.rst index 1ff5fa1df4..e1f39c04cc 100644 --- a/docs/sphinx/source/user_guide/modeling_topics/spectrum.rst +++ b/docs/sphinx/source/user_guide/modeling_topics/spectrum.rst @@ -83,9 +83,8 @@ References ---------- .. [1] A. Driesse, J. S. Stein, and M. Theristis, "Global horizontal spectral irradiance and module spectral response measurements: an open dataset - for PV research Sandia National Laboratories, ALbuquerque, NM, USA, Rep. - SAND2023-02045, 2023. Available: - https://datahub.duramat.org/dataset/module-sr-library + for PV research," Sandia National Laboratories, Albuquerque, NM, USA, Rep. + SAND2023-02045, 2023. :doi:`10.2172/1962943` .. [2] R. Daxini and Y. Wu, "Review of methods to account for the solar spectral influence on photovoltaic device performance," Energy, vol. 286, p. 129461, Jan. 2024. :doi:`10.1016/j.energy.2023.129461` diff --git a/docs/sphinx/source/whatsnew/v0.16.2.rst b/docs/sphinx/source/whatsnew/v0.16.2.rst index 64132a2547..9fa7a0d17f 100644 --- a/docs/sphinx/source/whatsnew/v0.16.2.rst +++ b/docs/sphinx/source/whatsnew/v0.16.2.rst @@ -40,6 +40,8 @@ Documentation * Clarify that :py:func:`pvlib.ivtools.sdm.fit_pvsyst_sandia` and :py:func:`pvlib.ivtools.sdm.fit_desoto_sandia` require multiple IV curves. (:issue:`1715`, :pull:`2883`) +* Fix broken internal and external documentation links in user guide, + tutorials, and style guide. (:issue:`2489`) Testing @@ -69,3 +71,4 @@ Contributors * jason-writer (:ghuser:`jason-writer`) * :ghuser:`bfs2021` * :ghuser:`xiajiahang` +* :ghuser:`sujalzombie01` diff --git a/docs/tutorials/irradiance.ipynb b/docs/tutorials/irradiance.ipynb index 251d8b5eb8..1faa45d47d 100644 --- a/docs/tutorials/irradiance.ipynb +++ b/docs/tutorials/irradiance.ipynb @@ -368,7 +368,7 @@ "source": [ "See the online documentation for clear sky modeling examples.\n", "\n", - "http://pvlib-python.readthedocs.io/en/stable/user_guide/clearsky.html\n", + "https://pvlib-python.readthedocs.io/en/stable/user_guide/modeling_topics/clearsky.html\n", "\n", "Here we only generate data for the functions below." ]