Skip to content

DOC: We can skip RTD now if we want#19854

Draft
pllim wants to merge 1 commit into
astropy:mainfrom
pllim:ci-skip-rtd
Draft

DOC: We can skip RTD now if we want#19854
pllim wants to merge 1 commit into
astropy:mainfrom
pllim:ci-skip-rtd

Conversation

@pllim
Copy link
Copy Markdown
Member

@pllim pllim commented Jun 2, 2026

Description

This pull request is to update the doc if we choose to expand [ci skip] and [skip ci] directives to ReadTheDocs also. This is something we need to agree on and then only I can update ReadTheDocs setting with the agreed upon changes.

If you do not want it like this, please provide clear alternatives.

Also see:

  • 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
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

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

By default the bot will run a code-style check on every push to a pull request with the
results reported in the checks section of the pull request. The bot will skip running
its check if a commit message contains ``[skip ci]``, ``[ci skip]``, ``[skip pre-commit.ci]``,
its check if a commit message contains ``[skip pre-commit.ci]``
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The pre-commit check runs regardless of [ci skip] and [skip ci], so I have to open a separate PR to correct just this if we reject this PR.

@pllim pllim added the testing label Jun 2, 2026
@astrofrog
Copy link
Copy Markdown
Member

It makes sense to me that [ci skip] should skip RTD so +1 from me

@mhvk
Copy link
Copy Markdown
Contributor

mhvk commented Jun 2, 2026

Agreed. I think perhaps we will want more fine-grained control (only skip docs, or only run docs), but it seems to me that can always be added later.

@pllim
Copy link
Copy Markdown
Member Author

pllim commented Jun 2, 2026

fine-grained control

Yes, I think it is all possible now with their automation rules.

can always be added later

I'd rather we just decide now because I have to go to RTD admin settings and also update the docs here. It will be confusing if we keep changing the rules.

@hamogu
Copy link
Copy Markdown
Member

hamogu commented Jun 3, 2026

I would prefer a separate [skip ci] and [skip docs].

It's common that someone comments on a PR and asks for just a few changes in the doc string as last comment after the code is good so the last commit only needs to run the docs. We also have PRs that only update the docs. Again, I just want to skip CI, but build docs.

Since [skip ci] is our established way of skipping just the CI (that's what it does right now, even if that's not by choice but due to RTDs inability to hook into it in the past), I suggest that it's the easiest to add a new and separate [skip docs].

I think it's more useful to control docs and code CI separately, even at the cost of sometimes having to type both of them.

@mhvk
Copy link
Copy Markdown
Contributor

mhvk commented Jun 3, 2026

I'd be a little bit happier with separate CI and docs skip options too. The only real cost would seem to be for a commit/PR that only touches comments or so.

@pllim
Copy link
Copy Markdown
Member Author

pllim commented Jun 3, 2026

They just published a blog about this feature. Do you want to give these links a read and see if any of the many ways we can configure is what you want? They allow filter by files changed too, though I am not sure how to tweak that in a fool-proof way, especially it is something done on admin side.

@mhvk
Copy link
Copy Markdown
Contributor

mhvk commented Jun 3, 2026

I indeed do not see how we can filter on files, since the docstrings also matter. But it does seem not running on [skip docs] is possible, so maybe just start with that?

@pllim
Copy link
Copy Markdown
Member Author

pllim commented Jun 3, 2026

OK choices, choices... which one? 😸

  1. [skip docs] and [docs skip]
  2. [skip doc] and [doc skip]
  3. [skip rtd] and [rtd skip]

@mhvk
Copy link
Copy Markdown
Contributor

mhvk commented Jun 3, 2026

I'm in favour of 1, since our directory is called docs too, but no strong opinion.

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.

4 participants