Skip to content

Fix broken internal sphinx references #1288

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

Merged
merged 4 commits into from
Aug 21, 2021
Merged

Conversation

kandersolar
Copy link
Member

  • [ ] Closes #xxxx
  • I am familiar with the contributing guidelines
  • [ ] Tests added
  • [ ] Updates entries to docs/sphinx/source/api.rst 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 and Milestone are assigned to the Pull Request and linked Issue.

Sphinx has a nitpicky mode to emit warnings for references to things it doesn't know about. I enabled it for a local build to see what it did and would not recommend it -- the output is several hundreds or thousands of lines of this:

pvsystem.py:docstring of pvlib.pvsystem.sapm_spectral_loss:: WARNING: py:class reference target not found: numeric
pvsystem.py:docstring of pvlib.pvsystem.sapm_spectral_loss:: WARNING: py:class reference target not found: dict-like
pvsystem.py:docstring of pvlib.pvsystem.scale_voltage_current_power:: WARNING: py:class reference target not found: DataFrame
pvsystem.py:docstring of pvlib.pvsystem.scale_voltage_current_power:: WARNING: py:class reference target not found: numeric
pvsystem.py:docstring of pvlib.pvsystem.scale_voltage_current_power:: WARNING: py:class reference target not found: default 1

But it did flag a few actual broken references that I've fixed here. Marked for 0.9 in anticipation of these changes not being controversial :)

@kandersolar kandersolar added this to the 0.9.0 milestone Aug 20, 2021
Copy link
Member

@wholmgren wholmgren left a comment

Choose a reason for hiding this comment

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

thanks @kanderso-nrel

@wholmgren wholmgren merged commit 6c857ae into pvlib:master Aug 21, 2021
@kandersolar kandersolar deleted the docsfixes branch August 21, 2021 03:22
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.

3 participants