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

[DOC]: sphinxcontrib-bibtex preview #2204

Closed
wants to merge 2 commits into from

Conversation

echedey-ls
Copy link
Contributor

@echedey-ls echedey-ls commented Sep 11, 2024

  • Preview of Standard citation style across docs #2202
  • 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.

See #2202 for context.

Let's keep conversation on whether this change is valuable to the repo in #2202, since there are some issues that must be taken into account:

TODO list

if we pursue this change:

Example

Only affects one function for now, pvlib.shading.shaded_fraction1d:

@echedey-ls echedey-ls changed the title sphinxcontrib-bibtex preview [DOC]: sphinxcontrib-bibtex preview Sep 11, 2024
@echedey-ls
Copy link
Contributor Author

Closing as discussed :)

@echedey-ls echedey-ls closed this Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant