Skip to content

Organize example gallery into sections #1351

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 5 commits into from
Dec 14, 2021

Conversation

kandersolar
Copy link
Member

@kandersolar kandersolar commented Dec 8, 2021

  • 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.

Following up on this discussion: #1279

This PR moves the gallery .py files into subdirectories so that they appear in sections on the rendered gallery page. I haven't done it here, but it is possible to specify the ordering of the sections (sphinx-gallery docs). Right now some sections only have one example; I hope that the gallery continues to grow and the sections will flesh out over time.

PR build here: https://pvlib-python--1351.org.readthedocs.build/en/1351/gallery/index.html

@kandersolar kandersolar added this to the 0.9.1 milestone Dec 8, 2021
@kandersolar kandersolar merged commit e105486 into pvlib:master Dec 14, 2021
@kandersolar kandersolar deleted the gallery_subfolders branch December 14, 2021 22:18
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.

2 participants