Skip to content

Commit

Permalink
docs: update navbar config and theming submodule (#1523)
Browse files Browse the repository at this point in the history
* update navbar config

* use latest quantinuum-sphinx

* fix some local build warnings
  • Loading branch information
CalMacCQ authored Aug 6, 2024
1 parent b94b204 commit afdd616
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 45 deletions.
83 changes: 39 additions & 44 deletions pytket/docs/_static/nav-config.js
Original file line number Diff line number Diff line change
@@ -1,46 +1,41 @@
const navConfig = {
const navConfig = {

"navTextLinks": [
{
"title": "API Docs",
"href": "../api-docs",
"pathMatch": "somewhere",
},
{
"title": "Examples",
"href": "../examples",
"pathMatch": "somewhere",
},
{
"title": "Blog",
"href": "../blog/",
"pathMatch": "somewhere",
},
{
"title": "User Manual",
"href": "../user-manual",
"pathMatch": "somewhere",
},
],
"navProductName": "TKET",
"navIconLinks": [
{
"title": "TKET Github",
"href": "https://github.com/CQCL/tket",
"pathMatch": "somewhere",
"iconImageURL": "_static/assets/github.svg",
},
{
"title": "TKET Slack Channel",
"href": "https://tketusers.slack.com/",
"pathMatch": "somewhere",
"iconImageURL": "_static/assets/slack.svg",
},
{
"title": "TKET Stack Exchange",
"href": "https://quantumcomputing.stackexchange.com/questions/tagged/pytket",
"pathMatch": "somewhere",
"iconImageURL": "_static/assets/stack.svg",
},
],
{
"title": "API Docs",
"href": "../../api-docs",
"pathMatch": "somewhere",
},
{
"title": "Blog",
"href": "../../blog/",
"pathMatch": "somewhere",
},
{
"title": "User Guide",
"href": "../../user-guide",
"pathMatch": "somewhere",
},
],
"navProductName": "TKET",
"navIconLinks": [
{
"title": "TKET Github",
"href": "https://github.com/CQCL/tket",
"pathMatch": "somewhere",
"iconImageURL": "/_static/assets/github.svg",
},
{
"title": "TKET Slack Channel",
"href": "https://tketusers.slack.com/",
"pathMatch": "somewhere",
"iconImageURL": "/_static/assets/slack.svg",
},
{
"title": "TKET Stack Exchange",
"href": "https://quantumcomputing.stackexchange.com/questions/tagged/pytket",
"pathMatch": "somewhere",
"iconImageURL": "/_static/assets/stack.svg",
},
],
}
3 changes: 3 additions & 0 deletions pytket/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,9 @@
# documentation.
#


exclude_patterns = ["build/jupyter_execute/*", ".venv/*"]

html_theme_options = {}

# Custom sidebar templates, must be a dictionary that maps document names
Expand Down

0 comments on commit afdd616

Please sign in to comment.