search

adafruit / adabot

Adabot is our robot friend who helps Adafruit online
MIT License
13 stars 27 forks source link

adding patch for sphinx-rtd-theme in docs/reqs #360

Closed FoamyGuy closed 11 months ago

FoamyGuy commented 1 year ago

patch that adds sphinx-rtd-theme into docs/requirements.txt which 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-theme used 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.

FoamyGuy commented 1 year ago

I started wondering why the actions CI were able to succeed in Github since we hadn't previously included sphinx-rtd-theme in a reqs file. It turns out that our actions has a step that does the install: https://github.com/adafruit/workflows-circuitpython-libs/blob/476e77fb0a3acd5aeaafaa943cc0dbf4e9fa3bcf/build/action.yml#L55

Theoretically it could be removed from the actions task if the change from this PR patch is adopted as long as something installs docs/requirements.txt then it'll get the theme. Though I don't think installing it twice should hurt anything either.

FoamyGuy commented 1 year ago

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.