-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Add logos and clarify some docstrings #688
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
Conversation
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.
- check the markdown for the image on README, it needs a preceding exclamation mark if you want it to show the image, and not just link to the file.
- also is there a way to view the rendered docs? do you have a separate read the docs account for pull requests?
thanks!
README.md
Outdated
@@ -1,4 +1,4 @@ | |||
pvlib-python | |||
[pvlib-python](docs/sphinx/source/_images/pvlib_logo_horiz.png) |
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.
need to add preceding exclamation mark for image to render, see GitHub Markdown guide

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. Do you know how to specify a display size?
I can make a pre-release tag that will build on readthedocs. Otherwise I don't know how to view the change to index.rst
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.
You can go into your readthedocs account and set up a new project that points to your fork. cwhanse-pvlib-python or something like that. Then you have to go into your new project's settings and turn on the build for your branch.
Alternatively, I can test locally if we're ready for that.
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.
I set up a readthedocs for my fork, that is the long-term solution.
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.
The index.rst
file renders in the viewer here.
Ready for review.
Codecov Report
@@ Coverage Diff @@
## master #688 +/- ##
=======================================
Coverage 92.57% 92.57%
=======================================
Files 52 52
Lines 7485 7485
=======================================
Hits 6929 6929
Misses 556 556
Continue to review full report at Codecov.
|
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. Looks good to me.
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.
Awesome, thanks! I'll go ahead and respond to NumFOCUS
@@ -1,5 +1,4 @@ | |||
pvlib-python | |||
============ | |||
<img src="docs/sphinx/source/_images/pvlib_logo_horiz.png" width="600" height="260"> |
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.
@cwhanse sorry to reopen this, but I think you should remove the height="260"
from the <img>
tag because it's rendering weird in my phone.
If I remove the height="260"
then it renders fine:
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.
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.
I did check when I clicked approve, and it seemed fine then, so not sure what happend :(
thanks for the attention to detail @mikofski ! |
pvlib python pull request guidelines
Thank you for your contribution to pvlib python! You may delete all of these instructions except for the list below.
You may submit a pull request with your code at any stage of completion.
The following items must be addressed before the code can be merged. Please don't hesitate to ask for help if you're unsure of how to accomplish any of the items below:
docs/sphinx/source/api.rst
for API changes.docs/sphinx/source/whatsnew
file for all changes.