-
-
Notifications
You must be signed in to change notification settings - Fork 79
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
update readthedocs link #239
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #239 +/- ##
=======================================
Coverage 48.29% 48.29%
=======================================
Files 12 12
Lines 1903 1903
=======================================
Hits 919 919
Misses 984 984 ☔ View full report in Codecov by Sentry. |
pyproject.toml
Outdated
@@ -55,7 +55,7 @@ packages = ["uncertainties", "uncertainties.unumpy"] | |||
[tool.setuptools_scm] | |||
|
|||
[project.urls] | |||
Documentation = "http://uncertainties-python-package.readthedocs.io/" | |||
Documentation = "http://uncertainties.readthedocs.io/" |
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.
this could/should use “https”
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.
@reneeotten Thanks - good catch and will fix.
.readthedocs.yml
Outdated
python: | ||
install: | ||
- requirements: doc/requirements.txt | ||
python: |
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.
sorry, I can only comment here… but since you’re making changes anyway… At the top of the file wouldn’t you want to use the latest released Python version and perhaps also the latest LTS version of Ubuntu?
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 - the current ReadTheDocs docs give a config with "ubuntu-22.04" and Python: "3.12". So, I'll go with Python 3.12. It is curious that the OS is not "ubuntu-latest". I'm OK with ubuntu 22, if that's what RTD wants...
I admit to being sort of "meh" on RTD, though I do also see advantages as part of a CI chain.
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 have never looked at it but given the flurry if commits/PRs here to get it to work it doesn't seem very user-friendly (or it's just that nobody knows how to use it 😉).
Not sure what the advantage in a CI workflow would be; just testing whether the documentation still builds we do for lmfit as well so you don't need RTD for that. And I am assuming that you're not planning to have a development version of the documentation online either.
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.
It's mostly that we need someone active with admin privileges to change the settings.
If GitHub pages was not used to update the docs, we'd have been forced to work out how to get rtd to build prs instead
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.
@andrewgsavage Thanks!
@reneeotten It is fair to say that I did not really understand how RTD works, (including how it runs sphinx-build) and did not try to run from a private repo. So, there was some flailing on the master branch partly to poke RTD and figure out how it works. I suppose I could have read the docs first ;)
I get the appeal of RTD: automatically render and publish the docs at every tagged release.
Using GitHub Pages could probably be automated. But I also do not mind the more deliberate step of building docs manually and pushing them to the gh-pages branch as part of the release process.
and also update some of README.rst