update docbuild (#47)

* update docbuild

* update link to repo

.github/workflows/docs/conf.py

@@ -10,9 +10,24 @@
     "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
     "sphinx.ext.mathjax",
+    "sphinx_copybutton",
 ]
 
-html_theme = "sphinx_rtd_theme"
+pygments_style = "borland"
+
+html_theme = "sphinx_book_theme"
+
+html_theme_options = {
+    "repository_url": "https://github.com/CQCL/pytket-iqm",
+    "use_repository_button": True,
+    "use_issues_button": True,
+}
+
+html_static_path = ["_static"]
+
+html_css_files = ["custom.css"]
+
+html_logo = "Quantinuum_logo.png"
 
 # -- Extension configuration -------------------------------------------------
 
@@ -29,13 +44,14 @@
 
 # The following code is for resolving broken hyperlinks in the doc.
 
-from sphinx.application import Sphinx
+import re
+from typing import Any, Dict, List, Optional
+from urllib.parse import urljoin
+
 from docutils import nodes
 from docutils.nodes import Element, TextElement
+from sphinx.application import Sphinx
 from sphinx.environment import BuildEnvironment
-from urllib.parse import urljoin
-import re
-from typing import Any, Dict, List, Optional
 
 # Mappings for broken hyperlinks that intersphinx cannot resolve
 external_url_mapping = {

.github/workflows/docs/requirements.txt

@@ -1,2 +1,3 @@
 sphinx ~= 4.3.2
-sphinx_rtd_theme
+sphinx_book_theme
+sphinx-copybutton

.gitignore

@@ -4,6 +4,7 @@ build
 dist
 *.pyc
 .vscode
+.venv
 .mypy_cache
 .hypothesis
 obj

docs/_static/custom.css

@@ -0,0 +1,44 @@
+.wy-side-nav-search,
+.wy-nav-top {
+    background: #5A46BE;
+}
+
+.wy-grid-for-nav,
+.wy-body-for-nav,
+.wy-nav-side,
+.wy-side-scroll,
+.wy-menu,
+.wy-menu-vertical {
+    background-color: #FFFFFF;
+}
+
+.wy-menu-vertical a:hover {
+    background-color: #d9d9d9;
+}
+
+.caption-text {
+    color: #000000;
+}
+
+.btn-link:visited,
+.btn-link,
+a:visited,
+.a.reference.external,
+.a.reference.internal,
+.wy-menu-vertical a,
+.wy-menu-vertical li,
+.wy-menu-vertical ul,
+.span.pre,
+.sig-param,
+.std.std-ref,
+a {
+    color: #544d4d;
+}
+
+:root {
+    --pst-color-inline-code: 199, 37, 78 !important;
+}
+
+.sig-name {
+    font-size: 1.25rem;
+}