Update documentation for release/0.10

Author: thiagocrepaldi

docs/source/_ext/quark_jupyter_notebook_build.py

@@ -1,13 +1,15 @@
 #
-# Copyright (C) 2023, Advanced Micro Devices, Inc. All rights reserved.
+# Copyright (C) 2025, Advanced Micro Devices, Inc. All rights reserved.
 # SPDX-License-Identifier: MIT
 #
 
 import os
+
 from sphinx.util import logging
 
 logger = logging.getLogger(__name__)
 
+
 def update_jupyter_notebook_toc_placeholder(app, docname, source):
     """
     Replace THE *.ipynb references by *.rst from @quark_jupyter_notebook_toc_placeholder@ toc when QUARK_SPHINX_BUILD_SKIP_TUTORIALS is set on env var
@@ -21,32 +23,43 @@ def update_jupyter_notebook_toc_placeholder(app, docname, source):
     ```
     """
 
-    jupyter_notebook_index_rst = os.path.join('source', 'jupyter_notebook_index.rst_')
+    jupyter_notebook_index_rst = os.path.join("source", "jupyter_notebook_index.rst_")
     if "READTHEDOCS" in os.environ:
         READTHEDOCS_REPOSITORY_PATH = os.environ.get("READTHEDOCS_REPOSITORY_PATH")
-        jupyter_notebook_index_rst = os.path.join(READTHEDOCS_REPOSITORY_PATH, 'docs', 'source', 'jupyter_notebook_index.rst_')
-    jupyter_notebook_toc_placeholder = '@quark_jupyter_notebook_toc_placeholder@'
-    with open(jupyter_notebook_index_rst, 'r') as f:
+        jupyter_notebook_index_rst = os.path.join(
+            READTHEDOCS_REPOSITORY_PATH, "docs", "source", "jupyter_notebook_index.rst_"
+        )
+    jupyter_notebook_toc_placeholder = "@quark_jupyter_notebook_toc_placeholder@"
+    with open(jupyter_notebook_index_rst) as f:
         quark_jupyter_notebook_toc = f.read().strip()
 
-    generate_jupyter_notebook_docs = "QUARK_SPHINX_BUILD_SKIP_TUTORIALS" not in os.environ or os.environ["QUARK_SPHINX_BUILD_SKIP_TUTORIALS"].lower() in ("0", "false", "off")
+    generate_jupyter_notebook_docs = "QUARK_SPHINX_BUILD_SKIP_TUTORIALS" not in os.environ or os.environ[
+        "QUARK_SPHINX_BUILD_SKIP_TUTORIALS"
+    ].lower() in ("0", "false", "off")
     if not generate_jupyter_notebook_docs:
-        quark_jupyter_notebook_toc = quark_jupyter_notebook_toc.replace('.ipynb', '.rst')
+        quark_jupyter_notebook_toc = quark_jupyter_notebook_toc.replace(".ipynb", ".rst")
 
-    if jupyter_notebook_toc_placeholder in source[0]:  # Only process documents containing `jupyter_notebook_toc_placeholder`
+    if (
+        jupyter_notebook_toc_placeholder in source[0]
+    ):  # Only process documents containing `jupyter_notebook_toc_placeholder`
         source[0] = source[0].replace(jupyter_notebook_toc_placeholder, quark_jupyter_notebook_toc)
-        if '.rst' in quark_jupyter_notebook_toc:
-            logger.info(f'Replaced {jupyter_notebook_toc_placeholder} with ReStructuredText tutorials at jupyter_notebook_index_rst and indexed by {docname}.rst')
+        if ".rst" in quark_jupyter_notebook_toc:
+            logger.info(
+                f"Replaced {jupyter_notebook_toc_placeholder} with ReStructuredText tutorials at jupyter_notebook_index_rst and indexed by {docname}.rst"
+            )
         else:
-            logger.info(f'Replaced {jupyter_notebook_toc_placeholder} with Jupyter Notebook tutorials at jupyter_notebook_index_rst and indexed by {docname}.rst')
+            logger.info(
+                f"Replaced {jupyter_notebook_toc_placeholder} with Jupyter Notebook tutorials at jupyter_notebook_index_rst and indexed by {docname}.rst"
+            )
+
 
 def setup(app):
     """
     Setup Sphinx extension
     """
-    app.connect('source-read', update_jupyter_notebook_toc_placeholder)
+    app.connect("source-read", update_jupyter_notebook_toc_placeholder)
     return {
-        'version': '1.0',
-        'parallel_read_safe': True,
-        'parallel_write_safe': True,
+        "version": "1.0",
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
     }

docs/source/_ext/quark_version_substitution.py

@@ -7,22 +7,24 @@
 
 logger = logging.getLogger(__name__)
 
+
 def update_release_placeholder(app, docname, source):
     """
     Replace all occurrences of @version@ with actual version number
     """
     release_version = app.config.release
-    if '@version@' in source[0]:  # Only process documents containing @version@
-        source[0] = source[0].replace('@version@', release_version)
-        logger.info(f'Replaced @version@ placeholder with Quark version {release_version} in {docname}.rst')
+    if "@version@" in source[0]:  # Only process documents containing @version@
+        source[0] = source[0].replace("@version@", release_version)
+        logger.info(f"Replaced @version@ placeholder with Quark version {release_version} in {docname}.rst")
+
 
 def setup(app):
     """
     Setup Sphinx extension
     """
-    app.connect('source-read', update_release_placeholder)
+    app.connect("source-read", update_release_placeholder)
     return {
-        'version': '1.0',
-        'parallel_read_safe': True,
-        'parallel_write_safe': True,
+        "version": "1.0",
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
     }