Skip to content
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.

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

Update outdated pvpmc.sandia.gov links in user guide #1789

Merged
merged 2 commits into from
Jun 29, 2023

Conversation

reepoi
Copy link
Contributor

@reepoi reepoi commented Jun 27, 2023

  • Closes Outdated pvpmc.sandia.gov links in user guide. #1788
  • I am familiar with the contributing guidelines
  • [ ] 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.

Fixes the two links mentioned in the issue. I am unsure what link to use for the PV_LIB Matlab help webpage.

@cwhanse
Copy link
Member

cwhanse commented Jun 27, 2023

I would point the PVLib for Matlab link to https://github.com/sandialabs/MATLAB_PV_LIB

@kandersolar kandersolar added this to the 0.10.0 milestone Jun 29, 2023
Copy link
Member

@kandersolar kandersolar left a comment

Choose a reason for hiding this comment

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

Thanks @reepoi!

As an aside, I recall there being some way to automatically detect broken links during the sphinx build. Maybe something to consider for the future.

@kandersolar kandersolar merged commit a506a47 into pvlib:main Jun 29, 2023
29 checks passed
@echedey-ls
Copy link
Contributor

automatically detect broken links during the sphinx build

Mind if I open a PR for that? It's just a line of code.

@kandersolar
Copy link
Member

@echedey-ls sure! My first thought is that it might significantly slow down the docs build, depending on what URLs it checks (e.g. every docstring DOI might take a long time...). Depending on that, we could add it to the CI, or just run it manually every so often. Probably broken links should be reported as warnings, not failures.

@echedey-ls
Copy link
Contributor

@kandersolar I've been looking a bit more into it.

For internal references there is the config value nitpicky = True, that would be useful but does not solve the problem. I think it is good enough to add: I'll open a PR at least for that.

On the other hand, for external links linkchecker builder has to be run.
I'm looking for a way to integrate it. From this comment it seems a bad idea to trigger that on every PR. In fact, all that conversation gives a good insight on how many things can go wrong with it.

I don't know how could I even take all the linkchecker output and create a test triggering that and determine if it passes or fails. There are many other occurrences out there to do link-checking, but I'm unable to find something that may work for PVLIB without problems.

Anyway, IMO the most promising approach is the one that is currently done at Matplotlib. See this instructions on the release procedure. And sorry for not bringing a better solution.

If an action could be made out of that, an action running weekly or so would be nice, like this one.

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

Successfully merging this pull request may close these issues.

Outdated pvpmc.sandia.gov links in user guide.
4 participants