Skip to content

DOC: fix broken links (NREL, EnergyPlus, git-scm, Wikipedia ΔT)#2818

Open
dgowdaan-cmyk wants to merge 2 commits into
pvlib:mainfrom
dgowdaan-cmyk:fix-broken-links
Open

DOC: fix broken links (NREL, EnergyPlus, git-scm, Wikipedia ΔT)#2818
dgowdaan-cmyk wants to merge 2 commits into
pvlib:mainfrom
dgowdaan-cmyk:fix-broken-links

Conversation

@dgowdaan-cmyk

Copy link
Copy Markdown
Contributor

Addresses #2489.

Ran make linkcheck on main and found several genuinely dead links (as opposed to false-positive 403s from bot-blocking sites like Wiley/ResearchGate/JSTOR, which I left alone since they work fine for real users).

This PR fixes:

  • pvlib.clearsky.bird: NREL restructured their URLs; updated to the current clear-sky model page (also fixed a long-standing nlr.govnrel.gov domain typo)
  • pvlib.spectrum.get_reference_spectra: same domain typo fix, updated ASTM G173 spectral data link to the current NREL landing page
  • pvlib.iotools.parse_epw: EnergyPlus documentation moved to readthedocs.io; updated both references
  • pvlib.solarposition.spa_c: fixed a malformed Wikipedia URL — an unencoded trailing parenthesis in %CE%94T_(timekeeping) was being misparsed by Sphinx's autolink detection as sentence punctuation, breaking the link
  • installation.rst: fixed git-scm.com/documentation (404) to git-scm.com/doc, matching the correct URL already used elsewhere in the same file

Verified locally: existing tests pass, flake8 clean on all touched files.

I found several more dead links (two prod.sandia.gov PDFs on a domain that no longer resolves, a PVGIS API example that should reference the current v5.3, and a couple of others I'm less confident about) — planning to follow up on those, either in this PR or a separate one, whichever @echedey-ls prefers.

  • Addresses More broken links (internal and external) #2489
  • I am familiar with the contributing guidelines
  • I attest that all AI-generated material has been vetted for accuracy and is in compliance with the pvlib license
  • Tests added
  • Updates entries in docs/sphinx/source/reference for API changes.
  • Adds description and name entries in the appropriate "what's new" file in docs/sphinx/source/whatsnew for all changes. Includes link to the GitHub Issue with :issue:`num` or this Pull Request with :pull:`num`. Includes contributor name and/or GitHub username (link with :ghuser:`user`).
  • New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.
  • Pull request is nearly complete and ready for detailed review.
  • Maintainer: Appropriate GitHub Labels (including remote-data) and Milestone are assigned to the Pull Request and linked Issue.

Comment on lines +50 to +51
an Excel file distributed by NREL, which is found here [2]_:
https://www.nrel.gov/grid/solar-resource/spectra-am1.5

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.

Suggested change
an Excel file distributed by NREL, which is found here [2]_:
https://www.nrel.gov/grid/solar-resource/spectra-am1.5
an Excel file distributed by NLR, which is found here [2]_:
https://www.nlr.gov/grid/solar-resource/spectra-am1.5

Any NREL domain changed to NLR last month. Attribution is to NLR, unless the reference is to a document and we're describing the publisher at the time of publication.

Irradiances: Direct Normal and Hemispherical on 37° Tilted Surface."
.. [2] “Reference Air Mass 1.5 Spectra.” NLR.
https://www.nlr.gov/grid/solar-resource/spectra-am1.5.html
https://www.nrel.gov/grid/solar-resource/spectra-am1.5

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.

Revert this change

@echedey-ls echedey-ls left a comment

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.

Please take the time to verify what you propose. Some changes just look like pure AI slop. Honestly, I was hesitant to directly close the PR and the issue - this is clearly the kind of contribution a human can do without much, if any, LLM generated content and the reason I agreed to you fixing it. Please understand we want contributors to know what they are doing or to learn from it while it gets done, and at the very least verifying the fixes.

I will leave this open since it already provides the amended fixes - if you are going to add commits in the future, I suggest you change it to "draft" (there are buttons on the web UI for that). If not, we will merge in the short term and close the issue.

`Forking Projects <https://guides.github.com/activities/forking/>`_,
`Fork A Repo <https://help.github.com/articles/fork-a-repo/>`_,
and the `git-scm <https://git-scm.com/documentation>`_ for
and the `git-scm <https://git-scm.com/doc>`_ for

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.

Suggested change
and the `git-scm <https://git-scm.com/doc>`_ for
and the `git-scm <https://git-scm.com/docs>`_ for

wrong url

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants