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

Fix readthedocs build #261

Merged
merged 5 commits into from
Aug 19, 2024
Merged

Fix readthedocs build #261

merged 5 commits into from
Aug 19, 2024

Conversation

jagerber48
Copy link
Contributor

@jagerber48 jagerber48 commented Jul 30, 2024

  • Closes readthedocs docs not building #254 (insert issue number)
  • Executed pre-commit run --all-files with no errors
  • The change is fully covered by automated unit tests
  • Documented in docs/ as appropriate
  • Added an entry to the CHANGES file

Readthedocs are still not building. I would like to test this PR on RTD before merging it in since it's taking a few tries to get this working. It's possible to do this test on a side branch like this while keeping the docs version hidden from the public.

@lebigot could you please make me and the other uncertainties maintainers to be maintainers on the uncertainties readthedocs project?

I believe this can be done with something along the lines of

  • Go to readthdocs account
  • Go into the uncertainties package
  • Go to "Admin"
  • Go to tab for "Maintainers"
  • Add maintainers by user name. I can be added under the username jagerber48. If you add me I would be happy to add the others.

Copy link

codecov bot commented Jul 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.46%. Comparing base (ce16269) to head (a2db160).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #261   +/-   ##
=======================================
  Coverage   96.46%   96.46%           
=======================================
  Files          16       16           
  Lines        1898     1898           
=======================================
  Hits         1831     1831           
  Misses         67       67           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lebigot
Copy link
Collaborator

lebigot commented Aug 6, 2024

@lebigot could you please make me and the other uncertainties maintainers to be maintainers on the uncertainties readthedocs project?

Thanks for the help. Done! @jagerber48, you have been invited to be a maintainer.

@jagerber48
Copy link
Contributor Author

@lebigot could you please make me and the other uncertainties maintainers to be maintainers on the uncertainties readthedocs project?

Thanks for the help. Done! @jagerber48, you have been invited to be a maintainer.

Thank you! That got me what I needed.

Ok great, I was able to set up readthedocs to detect pull requests and build docs. This is both causing docs to get built for pull requests so we can verify docs build appropriately and look correct. This is also nicely creating a new check in the PR automated checks

image

The built docs can be seen by clicking the link in the action: https://uncertainties--261.org.readthedocs.build/en/261/
The build report can be seen at https://readthedocs.org/projects/uncertainties/builds/25229286/

docs are building for this PR, it is ready for review/approval @newville

I have some more minor rtd config I'll be doing in the next day or so

newville
newville previously approved these changes Aug 13, 2024
@newville
Copy link
Member

@jagerber48 this seems ok to me. If we stick with readthedocs as the doc host, I would recommend that all code maintainers were readthedocs admins.

@jagerber48
Copy link
Contributor Author

@newville Sorry, I accidentally dismissed the approval by adding an entry for the changelog. I'll try to remember to do the changelog before requesting review in the future. I also see you accepted the invitation to be a maintainer on readthedocs, great. I wasn't to send an invite to @andrewgsavage or @wshanks since I couldn't find their accounts on readthedocs.

Copy link
Member

@newville newville left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry for the delay.... I just noticed that this was still pending approval.

@newville newville merged commit bb98e98 into lmfit:master Aug 19, 2024
21 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.

readthedocs docs not building
3 participants