docs: release 1.8.9

docs/source/conf.py

@@ -76,17 +76,19 @@
 # -- Options for autodoc extension ----------------------------------
 
 # Configure autodoc to show better signatures
-autodoc_typehints = 'description'
-autodoc_member_order = 'bysource'
+autodoc_typehints = "description"
+autodoc_member_order = "bysource"
 add_module_names = False  # Don't prepend module names to class/function names
 
 # -- Options for breathe extension ----------------------------------
 
 breathe_projects = {
-    "SampleModule": os.path.join(os.path.dirname(__file__), "examples/doxygen_output/xml")
+    "SampleModule": os.path.join(
+        os.path.dirname(__file__), "examples/doxygen_output/xml"
+    )
 }
 breathe_default_project = "SampleModule"
-breathe_default_members = ('members', 'undoc-members')
+breathe_default_members = ("members", "undoc-members")
 
 # -- Options for myst parser ----------------------------------------
 myst_enable_extensions = ["colon_fence"]

docs/source/configuration/ai-chatbot.rst

@@ -7,7 +7,7 @@ ScyllaDB Docs integrates with `Biel.ai <https://biel.ai/>`_ to offer a conversat
 The chatbot can answer documentation-related questions and provide relevant links to help users find the information they need quickly.
 
 .. note::
-    This feature is in beta and disabled by default. It will be gradually enabled for all documentation sites in a future release.  
+    This feature is in beta and disabled by default. It will be gradually enabled for all documentation sites in a future release.
     If you want to enable it now, please contact us in Slack (``#scylla-docs`` channel).
 
 Installation
@@ -24,7 +24,7 @@ To enable the AI chatbot, update your ``conf.py`` file by setting ``hide_ai_chat
 Usage
 -----
 
-Once enabled, the Ask AI button will appear in the documentation interface. 
+Once enabled, the Ask AI button will appear in the documentation interface.
 Users can click the button to start a conversation, ask questions, and receive responses with relevant documentation links.
 
 .. figure:: images/ai-chatbot.png
@@ -61,4 +61,3 @@ If the chatbot does not appear:
 * Check for errors in the browser console that may indicate issues with the integration.
 
 For more details, refer to the `Biel.ai documentation <https://docs.biel.ai/>`_.
-

docs/source/configuration/template.rst

@@ -311,7 +311,7 @@ Configuration options for enabling zendesk.
     - Description
   * - ``zendesk_tag``
     - string
-    - 
+    -
     - Zendesk verification tag. Example: ``gq6ltsh3nfex3cnwfy4aj9``.
 
 .. code:: python
@@ -334,6 +334,5 @@ Multiversion options
     - Description
   * - ``redirect``
     - string
-    - 
+    -
     - Overrides the default redirection of the main domain when using multiversion. By default, it redirects to ``<DOMAIN>/stable/``. Overriding setting this can be useful if the main domain page publishes multiple documentation sets. Example: ``/manual/stable/``.
-

docs/source/deployment/centralized-publication.rst

@@ -2,8 +2,8 @@
 Centralized publication
 =======================
 
-Certain core ScyllaDB projects are configured or published from the repository `scylladb/scylladb-docs-homepage <https://github.com/scylladb/scylladb-docs-homepage>`_ 
-instead of the project repository itself. 
+Certain core ScyllaDB projects are configured or published from the repository `scylladb/scylladb-docs-homepage <https://github.com/scylladb/scylladb-docs-homepage>`_
+instead of the project repository itself.
 
 This allows us to:
 
@@ -44,8 +44,8 @@ To add a new release to the centralized publication, submit a pull request to th
         {
             "tags": [],
             "branches": [
-                "master", 
-                "branch-2025.1", 
+                "master",
+                "branch-2025.1",
                 "branch-2025.2"
             ],
             "latest": "branch-2025.1",
@@ -63,8 +63,8 @@ To add a new release to the centralized publication, submit a pull request to th
         {
             "tags": [],
             "branches": [
-                "master", 
-                "branch-2025.1", 
+                "master",
+                "branch-2025.1",
                 "branch-2025.2"
             ],
             "latest": "branch-2025.2",
@@ -98,4 +98,3 @@ You can trigger a manual publication by following these steps:
 6. Click the green **Run workflow** button.
 
 For more details, see `Manually running a workflow <https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow>`_.
-

docs/source/examples/Doxyfile

@@ -25,4 +25,3 @@ EXTRACT_STATIC         = YES
 # Other settings
 QUIET                  = YES
 WARNINGS               = NO
-

docs/source/examples/__init__.py

@@ -1,2 +1 @@
 """Examples package for ScyllaDB Sphinx Theme documentation."""
-

docs/source/examples/_sample_module.h

@@ -26,7 +26,7 @@ class DatabaseConnection {
      * @param port The database port number (default: 9042)
      * @param username Optional username for authentication
      */
-    DatabaseConnection(const std::string& host, int port = 9042, 
+    DatabaseConnection(const std::string& host, int port = 9042,
                       const std::string& username = "");
 
     /**
@@ -79,4 +79,3 @@ std::string format_query(const std::string& query, int indent = 4);
 bool validate_connection_params(const std::string& host, int port);
 
 #endif // SAMPLE_MODULE_H
-

docs/source/examples/_sample_module.py

@@ -105,4 +105,3 @@ def validate_connection_params(host, port):
 
 MAX_RETRIES = 3
 """Maximum number of connection retry attempts"""
-

docs/source/examples/api-documentation/doxygen.rst

@@ -152,7 +152,7 @@ Configure in ``conf.py``:
 .. code-block:: python
 
    extensions = ['breathe', 'exhale']
-   
+
    exhale_args = {
        'containmentFolder': './api',
        'rootFileName': 'library_root.rst',
@@ -161,4 +161,3 @@ Configure in ``conf.py``:
    }
 
 Exhale will automatically create a page for each class, function, and file in your project.
-

docs/source/examples/api-documentation/index.rst

@@ -20,4 +20,3 @@ This approach keeps your API reference in sync with your codebase.
   * :doc:`Python <python>`
   * :doc:`Doxygen <doxygen>`
   * :doc:`REST API (Redocly) <rest-api>`
-

docs/source/examples/api-documentation/rest-api.rst

@@ -99,7 +99,7 @@ Create ``_ext/scylladb_openapi.py``:
        cmd = f"snippet-enricher-cli --targets='shell_curl' --input={output_file}"
 
        process = subprocess.Popen(cmd, shell=True,
-                           stdout=subprocess.PIPE, 
+                           stdout=subprocess.PIPE,
                            stderr=subprocess.PIPE)
 
        out, err = process.communicate()
@@ -251,4 +251,3 @@ Create ``_static/custom.css`` to style Redocly:
        color: inherit;
        background: transparent;
    }
-

docs/source/examples/code-blocks.rst

@@ -55,7 +55,7 @@ Renders:
 
 .. code-block:: rst
    :linenos:
-   
+
    Line 1
    Line 2
 
@@ -104,4 +104,4 @@ Renders:
 
    Line 1
    Line 2
-   Line 3
+   Line 3

docs/source/examples/diagrams.rst

@@ -1,4 +1,4 @@
-Diagrams 
+Diagrams
 ========
 
 The documentation toolchain supports rendering diagrams and charts using `Mermaid <https://mermaid.js.org/intro/>`_, a library designed for creating sequence diagrams, flowcharts, and other visualizations.
@@ -21,4 +21,4 @@ Renders:
    A --> B
    B -- Label --> C
 
-For more details, refer to the `sphinxcontrib-mermaid <https://sphinxcontrib-mermaid-demo.readthedocs.io/en/latest/>`_ documentation.
+For more details, refer to the `sphinxcontrib-mermaid <https://sphinxcontrib-mermaid-demo.readthedocs.io/en/latest/>`_ documentation.

docs/source/examples/doxygen_output/xml/compound.xsd

@@ -268,7 +268,7 @@
 
   <xsd:complexType name="descriptionType" mixed="true">
     <xsd:sequence>
-      <xsd:element name="title" type="xsd:string" minOccurs="0"/>	    
+      <xsd:element name="title" type="xsd:string" minOccurs="0"/>
       <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
       <xsd:element name="internal" type="docInternalType" minOccurs="0" maxOccurs="unbounded"/>
       <xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
@@ -1222,7 +1222,7 @@
 
   <xsd:complexType name="docCaptionType" mixed="true">
     <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
-    <xsd:attribute name="id" type="xsd:string" /> 
+    <xsd:attribute name="id" type="xsd:string" />
   </xsd:complexType>
 
   <xsd:simpleType name="range_1_6">
@@ -1278,7 +1278,7 @@
 
   <xsd:complexType name="docTocItemType" mixed="true">
     <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
-    <xsd:attribute name="id" type="xsd:string" /> 
+    <xsd:attribute name="id" type="xsd:string" />
   </xsd:complexType>
 
   <xsd:complexType name="docTocListType">
@@ -1291,14 +1291,14 @@
     <xsd:sequence>
       <xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
     </xsd:sequence>
-    <xsd:attribute name="langid" type="xsd:string" /> 
+    <xsd:attribute name="langid" type="xsd:string" />
   </xsd:complexType>
 
   <xsd:complexType name="docParamListType">
     <xsd:sequence>
       <xsd:element name="parameteritem" type="docParamListItem" minOccurs="0" maxOccurs="unbounded" />
     </xsd:sequence>
-    <xsd:attribute name="kind" type="DoxParamListKind" /> 
+    <xsd:attribute name="kind" type="DoxParamListKind" />
   </xsd:complexType>
 
   <xsd:complexType name="docParamListItem">
@@ -1333,7 +1333,7 @@
       <xsd:element name="xreftitle" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
       <xsd:element name="xrefdescription" type="descriptionType" />
     </xsd:sequence>
-    <xsd:attribute name="id" type="xsd:string" /> 
+    <xsd:attribute name="id" type="xsd:string" />
   </xsd:complexType>
 
   <xsd:complexType name="docCopyType">
@@ -1342,7 +1342,7 @@
       <xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
       <xsd:element name="internal" type="docInternalType" minOccurs="0" />
     </xsd:sequence>
-    <xsd:attribute name="link" type="xsd:string" /> 
+    <xsd:attribute name="link" type="xsd:string" />
   </xsd:complexType>
 
   <xsd:complexType name="docDetailsType">
@@ -1696,4 +1696,3 @@
   </xsd:simpleType>
 
 </xsd:schema>
-

docs/source/examples/doxygen_output/xml/index.xsd

@@ -28,7 +28,7 @@
     <xsd:attribute name="refid" type="xsd:string" use="required"/>
     <xsd:attribute name="kind" type="MemberKind" use="required"/>
   </xsd:complexType>
-  
+
   <xsd:simpleType name="CompoundKind">
     <xsd:restriction base="xsd:string">
       <xsd:enumeration value="class"/>
@@ -69,4 +69,3 @@
   </xsd:simpleType>
 
 </xsd:schema>
-

docs/source/examples/grid.rst

@@ -1,7 +1,7 @@
 Grid
 ====
 
-A custom directive that creates responsive grid layouts using Foundation's grid system. 
+A custom directive that creates responsive grid layouts using Foundation's grid system.
 Perfect for organizing topic boxes in rows and columns.
 
 .. note::
@@ -62,7 +62,7 @@ Supported Content
 The grid directive works exclusively with **topic-box** directives. Each topic-box within a grid should include Foundation grid classes in its ``:class:`` option to control layout:
 
 - ``large-3`` - 4 columns per row on desktop
-- ``large-4`` - 3 columns per row on desktop  
+- ``large-4`` - 3 columns per row on desktop
 - ``large-6`` - 2 columns per row on desktop
 - ``large-12`` - 1 column per row (full width)
 - ``small-6`` - 2 columns per row on mobile
@@ -264,4 +264,3 @@ Results in:
         :class: topic-box--product,large-4,small-6
 
         Documentation for ScyllaDB.
-

docs/source/examples/mascots.rst

@@ -211,4 +211,3 @@ Available mascot images:
 -  ``/_static/img/mascots-2/stretched-up.svg``
 -  ``/_static/img/mascots-2/toolbox.svg``
 -  ``/_static/img/mascots-2/university.svg``
-

docs/source/examples/topic-box.rst

@@ -1,7 +1,7 @@
 Topic box
 =========
 
-A custom directive that creates graphical boxes (cards) for navigation and content organization. 
+A custom directive that creates graphical boxes (cards) for navigation and content organization.
 
 Syntax
 ------
@@ -269,4 +269,3 @@ Results in:
     :class: topic-box--product
 
     Lorem ipsum dolor sit amet, consectetur adipiscing elit.
-

docs/source/examples/videos.rst

@@ -12,19 +12,19 @@ To embed a video using an iframe, use the ``raw`` directive with HTML content.
 
    .. raw:: html
 
-      <iframe width="560" height="315" style="max-width: 100%; margin-bottom: 1rem;" src="https://www.youtube.com/embed/-nPO9KeNydM?si=nE0Tpy7wM8D6fFYU" 
+      <iframe width="560" height="315" style="max-width: 100%; margin-bottom: 1rem;" src="https://www.youtube.com/embed/-nPO9KeNydM?si=nE0Tpy7wM8D6fFYU"
               title="YouTube video player" frameborder="0"
-              allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" 
+              allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
               referrerpolicy="strict-origin-when-cross-origin" allowfullscreen>
       </iframe>
 
 Renders as:
 
 .. raw:: html
 
-   <iframe width="560" height="315" src="https://www.youtube.com/embed/-nPO9KeNydM?si=nE0Tpy7wM8D6fFYU" 
-           title="YouTube video player" frameborder="0" 
-           allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" 
+   <iframe width="560" height="315" src="https://www.youtube.com/embed/-nPO9KeNydM?si=nE0Tpy7wM8D6fFYU"
+           title="YouTube video player" frameborder="0"
+           allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
            referrerpolicy="strict-origin-when-cross-origin" allowfullscreen>
    </iframe>
 
@@ -38,11 +38,11 @@ To make the iframe responsive and take the full width of the container while mai
    .. raw:: html
 
       <div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden; max-width: 100%; margin-bottom: 1rem;">
-         <iframe src="https://www.youtube.com/embed/-nPO9KeNydM?si=nE0Tpy7wM8D6fFYU" 
-                 title="YouTube video player" 
-                 frameborder="0" 
-                 allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" 
-                 referrerpolicy="strict-origin-when-cross-origin" 
+         <iframe src="https://www.youtube.com/embed/-nPO9KeNydM?si=nE0Tpy7wM8D6fFYU"
+                 title="YouTube video player"
+                 frameborder="0"
+                 allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
+                 referrerpolicy="strict-origin-when-cross-origin"
                  allowfullscreen
                  style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border: 0;">
          </iframe>
@@ -53,11 +53,11 @@ Renders as:
 .. raw:: html
 
    <div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden; max-width: 100%; margin-bottom: 1rem;">
-      <iframe src="https://www.youtube.com/embed/-nPO9KeNydM?si=nE0Tpy7wM8D6fFYU" 
-              title="YouTube video player" 
-              frameborder="0" 
-              allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" 
-              referrerpolicy="strict-origin-when-cross-origin" 
+      <iframe src="https://www.youtube.com/embed/-nPO9KeNydM?si=nE0Tpy7wM8D6fFYU"
+              title="YouTube video player"
+              frameborder="0"
+              allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
+              referrerpolicy="strict-origin-when-cross-origin"
               allowfullscreen
               style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border: 0;">
       </iframe>
@@ -70,4 +70,3 @@ Tips
 
 * **Aspect ratio**: Adjust ``padding-bottom`` to change the aspect ratio. For 16:9 use 56.25%, for 4:3 use 75%.
 * **Start time**: Add ``?start=60`` to start the video at a specific time (60 seconds in this example).
-

docs/source/upgrade/1-5-to-1-6.rst

@@ -48,4 +48,4 @@ Here are the main breaking changes between the 1.5 and 1.6 versions.
         cd docs
         make preview
 
-#. Review and address any warnings that may arise in the terminal during the build process.
+#. Review and address any warnings that may arise in the terminal during the build process.