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

DOC: Fix RTD #15184

Merged
merged 1 commit into from Aug 18, 2023
Merged

DOC: Fix RTD #15184

merged 1 commit into from Aug 18, 2023

Conversation

pllim
Copy link
Member

@pllim pllim commented Aug 17, 2023

Description

Do not use Sphinx 7.2.0 because it is incompatible with pydata-sphinx-theme. Sphinx just released 7.2.1 but not sure why RTD refuses to pick it up on rebuild triggers.

Fix #15193

Blocked by:

  • Wait for new sphinx-gallery release and then remove pin to its dev version (0.14.0 was released 2023-08-18)

Related issues:

  • By checking this box, the PR author has requested that maintainers do NOT use the "Squash and Merge" button. Maintainers should respect this when possible; however, the final decision is at the discretion of the maintainer that merges the PR.

@github-actions
Copy link

Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.

  • Do the proposed changes actually accomplish desired goals?
  • Do the proposed changes follow the Astropy coding guidelines?
  • Are tests added/updated as required? If so, do they follow the Astropy testing guidelines?
  • Are docs added/updated as required? If so, do they follow the Astropy documentation guidelines?
  • Is rebase and/or squash necessary? If so, please provide the author with appropriate instructions. Also see instructions for rebase and squash.
  • Did the CI pass? If no, are the failures related? If you need to run daily and weekly cron jobs as part of the PR, please apply the "Extra CI" label. Codestyle issues can be fixed by the bot.
  • Is a change log needed? If yes, did the change log check pass? If no, add the "no-changelog-entry-needed" label. If this is a manual backport, use the "skip-changelog-checks" label unless special changelog handling is necessary.
  • Is this a big PR that makes a "What's new?" entry worthwhile and if so, is (1) a "what's new" entry included in this PR and (2) the "whatsnew-needed" label applied?
  • Is a milestone set? Milestone must be set but we cannot check for it on Actions; do not let the green checkmark fool you.
  • At the time of adding the milestone, if the milestone set requires a backport to release branch(es), apply the appropriate "backport-X.Y.x" label(s) before merge.

@github-actions
Copy link

👋 Thank you for your draft pull request! Do you know that you can use [ci skip] or [skip ci] in your commit messages to skip running continuous integration tests until you are ready?

@AA-Turner
Copy link

@pllim pleae test with Sphinx 7.2.2, which has just been released.

A

@pllim pllim changed the title DOC: Do not use Sphinx 7.2.0 DOC: Fix RTD Aug 17, 2023
setup.cfg Outdated Show resolved Hide resolved
@pllim pllim modified the milestones: v6.0, v5.3.3 Aug 18, 2023
@pllim pllim added 💤 backport-v5.3.x on-merge: backport to v5.3.x and removed Upstream Fix Required 🔥 Critical labels Aug 18, 2023
@pllim pllim marked this pull request as ready for review August 18, 2023 21:21
@pllim pllim merged commit 05ebb1d into astropy:main Aug 18, 2023
28 of 30 checks passed
@pllim pllim deleted the rtd-pin-sphinx branch August 18, 2023 21:33
@lumberbot-app

This comment was marked as resolved.

pllim added a commit that referenced this pull request Aug 18, 2023
to unpin sphinx maxversion
@pllim
Copy link
Member Author

pllim commented Aug 18, 2023

Direct backport as 83bc27b

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.

DOC: Unpin sphinx<7.2 when we can
2 participants