DOC: We can skip RTD now if we want#19854
Conversation
[ci skip]
|
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.
|
| 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]`` |
There was a problem hiding this comment.
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.
|
It makes sense to me that [ci skip] should skip RTD so +1 from me |
|
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. |
Yes, I think it is all possible now with their automation rules.
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. |
|
I would prefer a separate 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 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. |
|
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. |
|
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. |
|
I indeed do not see how we can filter on files, since the docstrings also matter. But it does seem not running on |
|
OK choices, choices... which one? 😸
|
|
I'm in favour of 1, since our directory is called |
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: