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

Pin sphinx <7.0, docutils <0.18 #4196

Merged
merged 5 commits into from
Jul 15, 2023
Merged

Conversation

lilyminium
Copy link
Member

@lilyminium lilyminium commented Jul 14, 2023

Fixes #4177, #4194

Changes made in this Pull Request:

  • pinned sphinx <7.0
  • pinned docutils <0.18

PR Checklist

  • Tests?
  • Docs?
  • CHANGELOG updated?
  • Issue raised/referenced?

📚 Documentation preview 📚: https://mdanalysis--4196.org.readthedocs.build/en/4196/

@github-actions
Copy link

github-actions bot commented Jul 14, 2023

Linter Bot Results:

Hi @lilyminium! Thanks for making this PR. We linted your code and found the following:

There are currently no issues detected! 🎉

@codecov
Copy link

codecov bot commented Jul 14, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (2e39563) 93.61% compared to head (798db7b) 93.61%.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #4196   +/-   ##
========================================
  Coverage    93.61%   93.61%           
========================================
  Files          193      193           
  Lines        25170    25170           
  Branches      4059     4059           
========================================
  Hits         23562    23562           
  Misses        1092     1092           
  Partials       516      516           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@RMeli
Copy link
Member

RMeli commented Jul 14, 2023

I run into this too recently (RMeli/spyrmsd#77); the RTD theme is not compatible with sphinx>=7: readthedocs/sphinx_rtd_theme#1463.

@lilyminium
Copy link
Member Author

Thanks @RMeli! Yeah I was surprised that RTD wasn't also failing with that error. Turns out it seems to defualt to sphinx 5.0.2 anyway: https://readthedocs.org/api/v2/build/21298747.txt and https://readthedocs.org/api/v2/build/21305166.txt. It's still suitably messed
up: https://mdanalysis--4196.org.readthedocs.build/en/4196/documentation_pages/core/topologyattrs.html

I think I might have tracked it down to docutils updating to 0.18.1!

Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

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

The one question but otherwise I'll approve.

maintainer/conda/environment.yml Show resolved Hide resolved
@lilyminium lilyminium merged commit 5cea4f4 into MDAnalysis:develop Jul 15, 2023
23 of 24 checks passed
@lilyminium lilyminium deleted the fix-4177 branch July 15, 2023 04:58
@lilyminium lilyminium changed the title Try pinning sphinx <7.0 Pin sphinx <7.0, docutils <0.18 Jul 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] core/topologyattrs page format is broken
3 participants