Update conf.py

doc/source/conf.py

@@ -19,58 +19,108 @@
 import qibochem
 
 # -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "qibochem"
 copyright = "2023, The Qibo team"
 author = "The Qibo team"
-release = "0.0.1"
-# release = qibochem.__version__
 
+# The full version, including alpha/beta/rc tags
+release = qibochem.__version__
 
-# -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
+# -- General configuration ---------------------------------------------------
+#
+# https://stackoverflow.com/questions/56336234/build-fail-sphinx-error-contents-rst-not-found
 master_doc = "index"
 
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
 extensions = [
     "sphinx.ext.autodoc",
-    "sphinx.ext.napoleon",
     "sphinx.ext.doctest",
     "sphinx.ext.coverage",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.intersphinx",
+    "sphinx_copybutton",
     "recommonmark",
+    "nbsphinx",
     "sphinxcontrib.katex",
 ]
 
+# Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
+
+# Markdown configuration
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+source_suffix = {".rst": "restructuredtext", ".txt": "markdown", ".md": "markdown"}
+
+autosectionlabel_prefix_document = True
+# Allow to embed rst syntax in  markdown files.
+enable_eval_rst = True
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = []
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#
+
 html_theme = "furo"
+# html_favicon = "favicon.ico"
 
 # custom title
-html_title = "Version " + release
+html_title = "Qibochem · v" + release
 
-# custom html theme options (colors and font)
 html_theme_options = {
+    "top_of_page_button": "edit",
+    "source_repository": "https://github.com/qiboteam/qibochem/",
+    "source_branch": "main",
+    "source_directory": "doc/source/",
+    # "light_logo": "qibo_logo_dark.svg",
+    # "dark_logo": "qibo_logo_light.svg",
     "light_css_variables": {
         "color-brand-primary": "#6400FF",
         "color-brand-secondary": "#6400FF",
         "color-brand-content": "#6400FF",
-    }
+    },
+    "footer_icons": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/qiboteam/qibochem",
+            "html": """
+                    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
+                        <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
+                    </svg>
+                """,
+            "class": "",
+        },
+    ],
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-
 html_static_path = ["_static"]
 
+
+# -- Intersphinx  -------------------------------------------------------------
+
+intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
+
+
+# -- Doctest ------------------------------------------------------------------
+#
+
+doctest_path = [os.path.abspath("../examples")]
+
 # -- Autodoc ------------------------------------------------------------------
 #
 autodoc_member_order = "bysource"
@@ -85,6 +135,4 @@ def setup(app):
     app.add_css_file("css/style.css")
 
 
-# html_logo = "logo.png"
-
 html_show_sourcelink = False