Updated looks to match other qibo docs and updated poetry.toml

doc/source/conf.py

@@ -3,25 +3,64 @@
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+from recommonmark.transform import AutoStructify
+
+sys.path.insert(0, os.path.abspath(".."))
+import qibochem
+
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "qibochem"
-copyright = "2023, qiboteam"
-author = "qiboteam"
-release = "0.0.1"
+copyright = "The Qibo team"
+author = "The Qibo team"
+
+# 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
+# https://stackoverflow.com/questions/56336234/build-fail-sphinx-error-contents-rst-not-found
+master_doc = "index"
 
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.doctest",
     "sphinx.ext.coverage",
     "sphinxcontrib.katex",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.intersphinx",
+    "sphinx_copybutton",
+    "recommonmark",
+    "nbsphinx",
 ]
 
+# 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 = []
 
 
@@ -31,21 +70,66 @@
 # 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"
+
+
+# Adapted this from
+# https://github.com/readthedocs/recommonmark/blob/ddd56e7717e9745f11300059e4268e204138a6b1/docs/conf.py
+# app setup hook
+def setup(app):
+    app.add_config_value("recommonmark_config", {"enable_eval_rst": True}, True)
+    app.add_transform(AutoStructify)
+    app.add_css_file("css/style.css")
+
+
+html_show_sourcelink = False

doc/source/index.rst

@@ -16,6 +16,27 @@ Qibochem key features:
 * PySCF or Psi4 for calculation of 1- and 2-electron integrals
 * Unitary Coupled Cluster Ansatz
 
+
+How to Use the Documentation
+============================
+
+Welcome to the comprehensive documentation for ``Qibo``! This guide will help
+you navigate through the various sections and make the most of the resources
+available.
+
+1. **Installation and Setup**: Begin by referring to the
+   :doc:`/getting-started/index` guide to set up the ``Qibochem`` library in your environment.
+
+2. **Tutorials**: Explore the :doc:`/code-examples/index` section for a range of
+   tutorials that cater to different levels of expertise. These tutorials cover
+   basic examples, advanced examples and tutorials with algorithm for specific
+   applications.
+
+3. **API Documentation**: Dive into the :doc:`/api-reference/index` section,
+   which offers a detailed overview of the main components that constitute the
+   ``Qibochem`` API. This section provides a comprehensive understanding of the key
+   elements, helping you build a holistic view of the API's capabilities.
+
 Contents
 ========
 
@@ -31,3 +52,19 @@ Contents
 
     api-reference/index
     developer-guides/index
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Documentation links
+
+    Qibo docs <https://qibo.science/qibo/stable/>
+    Qibolab docs <https://qibo.science/qibolab/stable/>
+    Qibocal docs <https://qibo.science/qibocal/stable/>
+    Qibosoq docs <https://qibo.science/qibosoq/stable/>
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`