Skip to content

DOC: Use sphinx-automodapi for test runner docs again - #14318

Merged
pllim merged 1 commit into
astropy:mainfrom
pllim:readd-test-runner-docs
Jan 25, 2023
Merged

pllim merged 1 commit into
astropy:mainfrom
pllim:readd-test-runner-docs

Conversation

@pllim

@pllim pllim commented Jan 25, 2023 •

Copy link
Copy Markdown
Member

Description

This pull request is to revert #10477

Fixes #10478

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. 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 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.

to see if sphinx-automodapi is now compatible with Sphinx
@pllim pllim added this to the v5.3 milestone Jan 25, 2023
@pllim
pllim merged commit 86c046a into astropy:main Jan 25, 2023
@pllim
pllim deleted the readd-test-runner-docs branch January 25, 2023 19:03
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: Undo test runner API doc hack

1 participant