Skip to content

Fix for doctest failure#12235

Merged
nstarman merged 1 commit intoastropy:mainfrom
WilliamJamieson:bugfix/super_reference_doc_test_fail
Oct 9, 2021
Merged

Fix for doctest failure#12235
nstarman merged 1 commit intoastropy:mainfrom
WilliamJamieson:bugfix/super_reference_doc_test_fail

Conversation

@WilliamJamieson
Copy link
Contributor

@WilliamJamieson WilliamJamieson commented Oct 8, 2021

Description

Currently the docs build test is failing for most of the new astropy pull requests. This PR attempts to resolve the issues preventing the docs from building.

The issue preventing the docs build test from passing appears to be the way the codeguide.rst file was trying to link to the python docs super() documentation. This is probably due to some small changes in the python docs with the python 3.10 release.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • 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 "When to rebase and squash commits".
  • 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.
  • 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 a milestone set? Milestone must be set but astropy-bot check might be missing; 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 github-actions bot added the Docs label Oct 8, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Oct 8, 2021

👋 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?

@WilliamJamieson WilliamJamieson marked this pull request as ready for review October 8, 2021 21:49
@nden nden added this to the v5.0 milestone Oct 8, 2021
@nstarman nstarman merged commit ed769e1 into astropy:main Oct 9, 2021
@nstarman
Copy link
Member

nstarman commented Oct 9, 2021

Thanks @WilliamJamieson for the fix and @nden for the quick review.

@pllim
Copy link
Member

pllim commented Oct 11, 2021

For future reference, which other PR is this following up on? That is, which PR first broke it?

@WilliamJamieson WilliamJamieson deleted the bugfix/super_reference_doc_test_fail branch October 11, 2021 16:04
@nstarman
Copy link
Member

I think #12232 motivated this PR.

@saimn
Copy link
Contributor

saimn commented Oct 14, 2021

RTD is also failing on the 4.3 branch with those warnings.

@meeseeksdev backport to v4.3.x

meeseeksmachine pushed a commit to meeseeksmachine/astropy that referenced this pull request Oct 14, 2021
@pllim pllim modified the milestones: v5.0, v4.3.2 Oct 14, 2021
saimn added a commit that referenced this pull request Oct 14, 2021
…235-on-v4.3.x

Backport PR #12235 on branch v4.3.x (Fix for doctest failure)
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.

5 participants