-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
document class methods using sphinx3 recursive doc #1075
Conversation
Thanks @veronicaguo for opening this PR! I just quickly clicked through some API Reference pages, so I don't have thoughts on #1055 but here are a couple points about bumping the sphinx version:
.footnote-reference::before {
content: '[';
}
.footnote-reference::after {
content: ']';
} |
Thanks @kanderso-nrel for the feedback!
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interestingly, the reference list on the clearsky page renders differently from the ones in the docstrings. I wonder if it's because it's using citations instead of footnotes?
https://pvlib-python--1075.org.readthedocs.build/en/1075/clearsky.html#references
Not related to this PR, just something I saw while clicking through the pages: the comparison with the MATLAB version could use a refresh, specifically the details about our continuous integration setup.
Thanks @veronicaguo!
Also on the forecasting page: https://pvlib-python--1075.org.readthedocs.build/en/1075/forecasts.html#lar16 I have a mild preference for citation style for the narrative documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks @veronicaguo. @kanderso-nrel ok to merge?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
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`
).