Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update to latest sphinx-design #486

Merged
merged 4 commits into from
Apr 13, 2023
Merged

docs: update to latest sphinx-design #486

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6155b99
docs: fix use of sphinx-design
agoose77 Apr 3, 2023
cd39331
Merge branch 'master' into agoose77/fix-docs-build
agoose77 Apr 11, 2023
64e9bd1
Update pyproject.toml
agoose77 Apr 13, 2023
37c71e0
Merge branch 'master' into agoose77/fix-docs-build
agoose77 Apr 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ rtd = [
"plotly",
"sphinx-book-theme~=0.3.0",
"sphinx-copybutton",
"sphinx-design~=0.1.0",
"sphinx-design~=0.3.0",
Copy link
Member

Choose a reason for hiding this comment

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

Wanna bump this to 0.4.1? Or TBH just remove the pin?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

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.

Copy link
Member

Choose a reason for hiding this comment

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

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

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.

agoose77 marked this conversation as resolved.
Show resolved Hide resolved
"sphinxcontrib-bibtex",
"sympy",
]
Expand Down