docs: update to latest sphinx-design
#486
Conversation
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## master #486 +/- ##
=======================================
Coverage 81.47% 81.47%
=======================================
Files 29 29
Lines 2618 2618
=======================================
Hits 2133 2133
Misses 485 485
Flags with carried forward coverage won't be shown. Click here to find out more. Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
pyproject.toml
Outdated
| @@ -82,7 +82,7 @@ rtd = [ | |||
| "plotly", | |||
| "sphinx-book-theme~=0.3.0", | |||
| "sphinx-copybutton", | |||
| "sphinx-design~=0.1.0", | |||
| "sphinx-design~=0.3.0", | |||
There was a problem hiding this comment.
Wanna bump this to 0.4.1? Or TBH just remove the pin?
There was a problem hiding this comment.
In this case, because docs are an application rather than a library, we can pin onto ~=0.4.0 or even ==0.4.1. The former is probably strict enough for now.
There was a problem hiding this comment.
Yeah i think it's fine to pin too on theoretical grounds, I am just thinking of how to minimize maintainer toil needed against the risk that something randomly breaks (which imo is low in this case), so that we don't need PRs like this in the future
There was a problem hiding this comment.
Sure. I can't remember why the docs were broken before this PR, but I suspect it was because we didn't pin something that we should have. I think I'd prefer to manage docs like an app, so that we periodically bump all dependencies, rather than have them break at a random point down the line.
* docs: fix use of sphinx-design * Update pyproject.toml
A cryptic error message during our docs build is fixed in newer versions of
sphinx-design. This PR just bumps that RTD dependency.