Fix broken links #2594
Closed
Fix broken links #2594
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Fixes issue pvlib#2489 by correcting broken Sphinx cross-references: - Changed :ref:`Contributing` to :ref:`contributing` (case mismatch) - Changed :ref:`example_gallery` to :ref:`example-gallery` (underscore to hyphen) in two locations These references were causing broken links in the documentation when built with Sphinx linkchecker.
Fixes issue pvlib#2489 by addressing all broken links found by Sphinx linkchecker: **GitHub user profile links (404 errors):** - Removed broken :ghuser: directives for deleted GitHub accounts: solphie-pelland, thunderfish24, bhellis725, johnMoseleyArray, kanderso-nrel - Kept contributor names in whatsnew files without broken links **Archived repositories:** - Updated Sandia-Labs/PVLIB_Python reference to note it's archived **Updated GitHub documentation URLs:** - Fixed GitHub help.github.com anchor to use new docs.github.com URL - Removed broken anchor from CODE_OF_CONDUCT.md link **External documentation links:** - Fixed NREL legosti/old/761.pdf reference (now archived) - Updated NREL ASTM G173 spreadsheet reference (file no longer available) - Removed specific v5_2 version from PVGIS API examples - Fixed ResearchGate publication link (403 error) - Updated SolarAnywhere documentation links (520 errors) All changes maintain reference information while removing broken URLs that would fail linkchecker validation.
Corrects contributor GitHub usernames to their current handles instead of removing the :ghuser: directives: - thunderfish24 → markcampanelli - solphie-pelland → sophie-pelland - kanderso-nrel → kandersolar (10 files) - bhellis725 → benbenboben - Restored johnMoseleyArray (still valid) GitHub automatically redirects old usernames to new ones, but it's best practice to use the current username in documentation. Related to issue pvlib#2489.
The johnMoseleyArray username returns 404 and no current username was found. Keeping contributor name without GitHub link. Related to issue pvlib#2489.
Brings across improvements from bugfix/broken-links-review branch: **Added DOI references:** - SERI/TR-642-761: Added :doi:`10.2172/6510849` (pvlib/clearsky.py) - Huld et al 2009: Added :doi:`10.4229/24thEUPVSEC2009-5BV.1.99` (pvlib/spectrum/mismatch.py) **Updated documentation URLs:** - pydata-sphinx-theme: Updated from rtfd.io to readthedocs.io (docs/sphinx/source/conf.py) - Pandas contributing guide: Updated to current URL (docs/sphinx/source/contributing/how_to_contribute_new_code.rst) - GitHub docs: Updated "Set Up Git" and "Using Pull Requests" URLs (docs/sphinx/source/contributing/how_to_contribute_new_code.rst) **Fixed SolarAnywhere references:** - Added proper CleanPower developer documentation URLs: - irradiance-and-weather-requests - complete-schema/createweatherdatarequest/options - overview-of-data-fields - historical-irradiance-datasets - Applied to pvlib/iotools/solaranywhere.py and pvlib/iotools/tmy.py **Fixed Sandia Labs reference:** - Updated to point to correct MATLAB_PV_LIB repository instead of archived PVLIB_Python (docs/sphinx/source/whatsnew/v0.1.0.txt) These changes provide working links and proper DOI references instead of just removing broken URLs. Related to issue pvlib#2489.
Addresses style guide compliance issues: **pvlib/clearsky.py:** - Merged duplicate references [1] and [4] (both SERI/TR-642-761) - Reformatted [1] to match IEEE technical report style: * Added "Rep." prefix before report number * Added "USA" country designation * Integrated DOI into proper reference format * Fixed author name spacing (R. L. Hulstrom) - Renumbered [5] to [4] after removing duplicate **pvlib/spectrum/mismatch.py:** - Reformatted Huld et al. conference paper to match IEEE style: * Changed author format from "Huld, T." to "T. Huld" * Changed "In Proceedings of" to "In Proc." * Removed redundant year * Added proper punctuation and comma placement Both references now follow the IEEE style guide format shown in docs/sphinx/source/contributing/style_guide.rst (lines 123-156). Related to issue pvlib#2489.
josephradford deleted the claude/fix-user-guide-references-011CUqm3svwiedmRQhVm4pRi branch Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Tests addedN/AUpdates entries inN/Adocs/sphinx/source/referencefor API changes.docs/sphinx/source/whatsnewfor 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.N/Aremote-data) and Milestone are assigned to the Pull Request and linked Issue.Used Claude Code to review all links in project and find suitable alternatives.