docs: Use new Quantinuum docs theme #519
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #519 +/- ##
=======================================
Coverage 91.39% 91.39%
=======================================
Files 59 59
Lines 6481 6481
=======================================
Hits 5923 5923
Misses 558 558 ☔ View full report in Codecov by Sentry. |
mark-koch
had a problem deploying
to
github-pages
GitHub Actions
Failure
acl-cqc
left a comment
acl-cqc
left a comment
There was a problem hiding this comment.
Sorry, missed the notification for this one. I am completely not a docs expert, in fact the complete opposite, but the guide at the URL you've added was good :-) :-)
| html_static_path = ["../_static"] | ||
| html_css_files = ["custom.css"] | ||
| templates_path = ["_templates", "../quantinuum-sphinx/_templates"] | ||
| html_static_path = ["../_static", "../quantinuum-sphinx/_static"] |
There was a problem hiding this comment.
super-nit: according to https://github.com/CQCL/quantinuum-sphinx, these should be ordered the other way around
|
|
||
| html_theme = "furo" | ||
| html_title = "Guppy compiler development docs" | ||
| html_theme_options = {} |
There was a problem hiding this comment.
Necessary or just good for explicitness? (Happy either way, but if the latter, might be good to add a comment at line end)
There was a problem hiding this comment.
Not sure, I copied this from Quantinuum/hugr#1267
|
|
||
| html_theme = "sphinx_book_theme" | ||
|
|
||
| html_theme = "furo" |
There was a problem hiding this comment.
Also I think you are supposed to add html_favicon??
| @@ -0,0 +1,13 @@ | |||
| const navConfig = { | |||
| "navTextLinks": [ | |||
|
|
|||
There was a problem hiding this comment.
Not sure what we should have in the navbar. Any ideas what to put here?
| version = 1 | ||
| requires-python = ">=3.10, <3.13" | ||
| resolution-markers = [ | ||
| "python_full_version < '3.13'", |
There was a problem hiding this comment.
This looks odd, given requires-python explicitly excludes 3.13 (<3.13 not <=3.13) ??
There was a problem hiding this comment.
I was confused about it, but it seems okay according to astral-sh/uv#6795
|
now done in #1031 |
|
Closed by #1031 |
Closes #368
Based on Quantinuum/hugr#1267
Page artifact can be downloaded here: https://github.com/CQCL/guppylang/actions/runs/11127889369/artifacts/2001389346