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

Set up sphinx gallery; add clearsky.reno example #127

Merged
merged 9 commits into from Feb 16, 2022

Conversation

kandersolar
Copy link
Member

@kandersolar kandersolar commented Jan 26, 2022

Description

This PR:

  • Sets up an example gallery using sphinx-gallery: link
  • Adds a short example of clearsky.reno: link
  • Configures function-level docs pages to have a "mini-gallery" at the bottom listing examples using that function: link

Checklist

  • Closes Sphinx docs don't show example usage #125
  • Added new API functions to docs/api.rst
  • Clearly documented all new API functions with PEP257 and numpydoc compliant docstrings
  • Adds description and name entries in the appropriate "what's new" file
    in docs/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`).
  • Non-API functions clearly documented with docstrings or comments as necessary
  • Added tests to cover all new or modified code
  • Pull request is nearly complete and ready for detailed review

@kandersolar kandersolar added the documentation Improvements or additions to documentation label Jan 26, 2022
@kandersolar kandersolar marked this pull request as ready for review January 27, 2022 17:58
@kandersolar
Copy link
Member Author

Ok, this one is ready now too. Right now the example makes a network request; maybe we should change that to use a small file in pvanalytics/data?

@cwhanse
Copy link
Member

cwhanse commented Jan 27, 2022

+1 to adding a file to pvanalytics/data. Getting remote data for tests is a frequent maintenance issue. OK with me to leave the code for getting the data in the example as a comment.

@cwhanse
Copy link
Member

cwhanse commented Feb 16, 2022

This is great, thank @kanderso-nrel

@cwhanse cwhanse merged commit 27ec167 into pvlib:master Feb 16, 2022
@kandersolar kandersolar deleted the sphinx-gallery branch February 16, 2022 19:47
@cwhanse cwhanse mentioned this pull request Feb 16, 2022
2 tasks
@kandersolar kandersolar added this to the v0.1.1 milestone Feb 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sphinx docs don't show example usage
2 participants