Skip to content

Fix broken internal and external documentation links (#2489) #2918

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sujalzombie01 wants to merge 1 commit into from
Closed

Fix broken internal and external documentation links (#2489) #2918

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down
6 changes: 3 additions & 3 deletions docs/sphinx/source/contributing/style_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
3 changes: 1 addition & 2 deletions docs/sphinx/source/user_guide/getting_started/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,7 @@ Set up a virtual environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

We strongly recommend working in a `virtual environment
<http://astropy.readthedocs.org/en/latest/development/workflow/
virtual_pythons.html>`_ if you're going to use an editable version
<https://docs.python.org/3/tutorial/venv.html>`_ 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
Expand Down
5 changes: 2 additions & 3 deletions docs/sphinx/source/user_guide/modeling_topics/spectrum.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`

@RDaxini RDaxini Oct 21, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not only the incorrect DOI for this publication, but this DOI does not even exist.

.. [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`
Expand Down
3 changes: 3 additions & 0 deletions docs/sphinx/source/whatsnew/v0.16.2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -69,3 +71,4 @@ Contributors
* jason-writer (:ghuser:`jason-writer`)
* :ghuser:`bfs2021`
* :ghuser:`xiajiahang`
* :ghuser:`sujalzombie01`
2 changes: 1 addition & 1 deletion docs/tutorials/irradiance.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
]
Expand Down
Loading