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

update readthedocs link #239

Merged
merged 4 commits into from
Jun 6, 2024
Merged

update readthedocs link #239

merged 4 commits into from
Jun 6, 2024

Conversation

newville
Copy link
Member

@newville newville commented Jun 5, 2024

and also update some of README.rst

newville added 2 commits June 4, 2024 21:10

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Copy link

codecov bot commented Jun 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 48.29%. Comparing base (166a56b) to head (b6ca5c0).

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.
📢 Have feedback on the report? Share it here.

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/"
Copy link
Collaborator

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”

Copy link
Member Author

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:
Copy link
Collaborator

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?

Copy link
Member Author

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.

Copy link
Collaborator

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.

Copy link
Contributor

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

Copy link
Member Author

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.

@newville newville requested review from reneeotten and a team June 6, 2024 02:06
@andrewgsavage andrewgsavage merged commit 34a271f into lmfit:master Jun 6, 2024
18 checks passed
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.

None yet

3 participants