adding patch for sphinx-rtd-theme in docs/reqs #360
Conversation
|
I started wondering why the actions CI were able to succeed in Github since we hadn't previously included Theoretically it could be removed from the actions task if the change from this PR patch is adopted as long as something installs |
| -- | ||
| -- |
There was a problem hiding this comment.
I just noticed this: something, probably pre-commit, removed a space after --. The special sequence -- has particular meaning in a git patch file. pre-commit needs to be instructed not to run the trailing whitespace on "*.patch" files, probably with an exclude directive, see under https://pre-commit.com/#adding-pre-commit-plugins-to-your-project
There was a problem hiding this comment.
--[no-]signature=<signature>
Add a signature to each message produced. Per RFC 3676 the
signature is separated from the body by a line with '-- ' on it. If
the signature option is omitted the signature defaults to the Git
version number.
or you could instruct git format-patch to not produce the "signature" part
There was a problem hiding this comment.
Did you get a chance to respond to this review comment? if so, I missed it
There was a problem hiding this comment.
I didn't see any messages on this page until coming back to it now. Weird, I'm not sure why it wasn't showing me the comments from last week.
I'll make one with that no signature flag and commit the one that it produces. Thank you
| sphinx>=4.0.0 | ||
| sphinxcontrib-jquery | ||
| +sphinx-rtd-theme | ||
| -- |
There was a problem hiding this comment.
This trailing space needs to remain, otherwise the file is not a proper git patch. Pre commit needs to be told to leave it. I left a review with more detail last week but it's still "pending" and I can't figure out how to finish it from phone. Sorry for the lack of detail
There was a problem hiding this comment.
Oh I guess it posted them all at once. Doh.
|
Nice catch and thanks again Jeff! Pre-commit was innocent in this instance. The culprit was my IDE, there is a setting that automatically strips trailing spaces in some situations. It took effect when I copied the patch file into the project and then saved it. I hadn't realized it was doing that before, but I've disabled it now. The latest commit adds back in the space. After thinking about it more I decided against the --no-signature patch, I figured there is some chance that the version of the git client that produced the patch may be helpful to know some day. |
patch that adds
sphinx-rtd-themeintodocs/requirements.txtwhich is needed since a change in RTD behavior starting 10/3 outlined in this post: https://blog.readthedocs.com/defaulting-latest-build-tools/For our usage the crux is that
sphinx-rtd-themeused to be installed automatically, but no longer is so we need to specify it in a requirements file in order for it to be installed moving forward.