{"id":22882527,"url":"https://github.com/cqcl/quantinuum-sphinx","last_synced_at":"2025-03-31T16:38:22.187Z","repository":{"id":246895316,"uuid":"822597203","full_name":"CQCL/quantinuum-sphinx","owner":"CQCL","description":"Quantinuum branded templates and assets for Sphinx documentation.","archived":false,"fork":false,"pushed_at":"2024-10-28T10:49:50.000Z","size":1298,"stargazers_count":1,"open_issues_count":3,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-06T21:45:55.380Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CQCL.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-01T12:55:47.000Z","updated_at":"2024-10-28T10:49:11.000Z","dependencies_parsed_at":"2024-07-05T19:57:35.392Z","dependency_job_id":"c0f021a7-f39c-4452-8443-90abd732e758","html_url":"https://github.com/CQCL/quantinuum-sphinx","commit_stats":null,"previous_names":["cqcl/quantinuum-sphinx"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fquantinuum-sphinx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fquantinuum-sphinx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fquantinuum-sphinx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fquantinuum-sphinx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CQCL","download_url":"https://codeload.github.com/CQCL/quantinuum-sphinx/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246499304,"owners_count":20787478,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-13T18:18:10.071Z","updated_at":"2025-03-31T16:38:22.161Z","avatar_url":"https://github.com/CQCL.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Quantinuum Sphinx\n\nThis repo contains templates and static assets that are intended to customize the theme [furo](https://pradyunsg.me/furo/).\n\n\n### Using the templates in your Sphinx configuration\n\nAdd the following git URL as a submodule in the same directory as `conf.py`\n\n```bash\ngit submodule add -b dist https://github.com/CQCL/quantinuum-sphinx.git\n```\n\nIn `conf.py` add:\n\n```python\nhtml_theme = \"furo\"\ntemplates_path = [\"quantinuum-sphinx/_templates\"]\nhtml_static_path = ['quantinuum-sphinx/_static', '_static']\nhtml_favicon = 'quantinuum-sphinx/_static/assets/quantinuum_favicon.svg'\n```\n\nCreate a file `./_static/nav-config.js` containing: \n\n```js\nconst navConfig = {\n    \"navTextLinks\": [\n        {\n            \"title\": string,\n            \"href\": string,\n        },\n    ],\n    \"navProductName\": string,\n    \"navIconLinks\": [\n        {\n            \"title\": string,\n            \"href\": string,\n            \"iconImageURL\": string (i.e. \"_static/assets/github.svg\"),\n        },\n    ],\n}\n```\n\nRebuild your docs and you should have a navbar:\n![Screenshot 2024-07-01 at 14 07 19](https://github.com/CQCL/quantinuum-sphinx/assets/104831665/1dfda0e7-accc-428c-bccd-b489913bf9aa)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcqcl%2Fquantinuum-sphinx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcqcl%2Fquantinuum-sphinx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcqcl%2Fquantinuum-sphinx/lists"}