-
Notifications
You must be signed in to change notification settings - Fork 107
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
fix read the docs build with automatic versioning #182
Conversation
@JessicaS11 I guess if there's already a readthedocs automated test, then we can just remove the github workflow one! |
Thanks for figuring all this out! Sorry I wasn't much help here haha Not super familiar with readthedocs and setuptools_scm! 😛 |
Facepalm. Good point. Okay... here come the edits. |
This reverts commit edc5d66.
Was just about to say this too!
Don't worry Don, I don't think many of us are good with it too, we just keep trying stuff until it works pretty much! |
Codecov Report
@@ Coverage Diff @@
## development #182 +/- ##
============================================
Coverage 48.17% 48.17%
============================================
Files 17 17
Lines 1179 1179
Branches 262 262
============================================
Hits 568 568
Misses 570 570
Partials 41 41 Continue to review full report at Codecov.
|
This reverts commit a7fbd8c.
doc/source/conf.py
Outdated
# -- Versioning with setuptools_scm ------------------------------------------ | ||
from pkg_resources import get_distribution | ||
release = get_distribution('icepyx').version | ||
# for example take major/minor | ||
version = '.'.join(release.split('.')[:2]) | ||
|
||
|
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.
So do we need this still? Or can we get rid of it?
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.
Good question, I tried deleting these lines locally and running cd icepyx/doc && make html
works. Could you try and remove them and see if the readthedocs build passes still?
Probably best to revert the dev .ipynb notebooks removal too to keep this PR clean:
|
This reverts commit 7a56f48.
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.
Amazing what 2 lines of code can do! Great job team!
An alternative to #181 (as suggested there), this adds the setuptools method to the
readthedocs.yml
and successfully builds on read the docs.