[misc] doc generation addition

Author: rusher

.github/workflows/release.yml

@@ -0,0 +1,65 @@
+name: Generate Docs and Update Documentation Repository
+
+on:
+  push:
+  workflow_dispatch:  # Allow manual triggering
+
+jobs:
+  update-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Python project
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          # Install your project dependencies
+          pip install -r docs/requirements.txt
+          pip install -e .
+
+      - name: Generate Sphinx documentation
+        run: |
+          sphinx-build -b markdown docs/source docs/_build/markdown
+
+      - name: Checkout documentation repository
+        uses: actions/checkout@v4
+        with:
+          repository: rusher/mariadb-docs  # Replace with actual repo
+          token: ${{ secrets.DOCS_REPO_TOKEN }}
+          path: docs-repo
+
+      - name: Update documentation subdirectory
+        run: |
+          # Remove existing documentation in target subdirectory
+          rm -rf docs-repo/mariadb-docs/connectors/mariadb-connector-python/api/*
+          
+          # Copy new documentation
+          cp -r docs/_build/markdown/* docs-repo/mariadb-docs/connectors/mariadb-connector-python/api/
+          
+          # Optional: Add any additional processing here
+          # e.g., update index files, fix relative links, etc.
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v5
+        with:
+          token: ${{ secrets.DOCS_REPO_TOKEN }}
+          path: docs-repo
+          commit-message: "Update API documentation from ${{ github.repository }}"
+          title: "Auto-update: API Documentation from ${{ github.repository }}"
+          body: |
+            This PR automatically updates the documentation subdirectory with the latest Sphinx-generated markdown from [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}).
+            
+            **Changes:**
+            - Updated documentation generated from commit ${{ github.sha }}
+            - Generated on: ${{ github.run_id }}
+            
+          branch: auto-docs-update-${{ github.run_number }}
+          delete-branch: true

.readthedocs.yml

@@ -7,7 +7,7 @@ version: 2
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-  configuration: doc/source/conf.py
+  configuration: docs/source/conf.py
 
 # Build documentation with MkDocs
 #mkdocs:
@@ -16,8 +16,7 @@ sphinx:
 # Optionally build your docs in additional formats such as PDF and ePub
 formats: all
 
-# Optionally set the version of Python and requirements required to build your docs
-#python:
-#  version: 3.7
-#  install:
-#    - requirements: docs/requirements.txt
+# Ensure the necessary Python dependencies are installed
+python:
+  install:
+    - requirements: docs/requirements.txt

docs/examples/basic01.py

@@ -0,0 +1,36 @@
+# Import MariaDB Connector/Python module
+import mariadb
+
+# connection parameters
+conn_params= {
+    "user" : "example_user",
+    "password" : "GHbe_Su3B8",
+    "host" : "localhost",
+    "database" : "test"
+}
+
+# Establish a connection
+connection= mariadb.connect(**conn_params)
+
+cursor= connection.cursor()
+
+# Create a database table
+cursor.execute("DROP TABLE IF EXISTS mytest")
+cursor.execute("CREATE TABLE mytest(id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,"
+               "first_name VARCHAR(100), last_name VARCHAR(100))")
+
+
+# Populate table with some data
+cursor.execute("INSERT INTO mytest(first_name, last_name) VALUES (?,?)",
+               ("Robert", "Redford"))
+
+# retrieve data
+cursor.execute("SELECT id, first_name, last_name FROM mytest")
+
+# print content
+row= cursor.fetchone()
+print(*row, sep='\t')
+
+# free resources
+cursor.close()
+connection.close()

docs/requirements.txt

@@ -0,0 +1,3 @@
+sphinx
+myst-parser
+sphinx-markdown-builder

docs/source/api.rst

@@ -0,0 +1,16 @@
+-------------
+API Reference
+-------------
+
+.. sectionauthor:: Georg Richter <georg@mariadb.com>
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   module
+   connection
+   cursor
+   pool
+   constants 
+

docs/source/bugs.rst

@@ -0,0 +1,48 @@
+Bug reports
+===========
+
+If you think that you have found a bug in MariaDB Software, please report it at
+`Jira issue tracker <https://jira.mariadb.org>`_ and file it under Project CONPY (abbreviation for Connector/Python).
+
+How to report a bug?
+--------------------
+
+Search first
+^^^^^^^^^^^^
+Always search the bug database first. Especially if you are using an older version of MariaDB Connector/Python it could
+be reported already by someone else or it was already fixed in a more recent version.
+
+What?
+^^^^^
+We need to know what you did, what happened and what you wanted to happen. A report stating that method xyz() hangs, will
+not allow us to provide you with an advice or fix, since we just don't know what the method is doing.
+Beside versions a good bug report contains a short script which reproduces the problem. Sometimes it is also necessary to
+provide the definition (and data) of used tables.
+
+Versions of components
+^^^^^^^^^^^^^^^^^^^^^^
+MariaDB Connector/Python interacts with two other components: The database server and MariaDB Connector/C. Latter one is responsible for client/server communication. An error does not necessarily have to exist in Connector / Python; it can also be an error in the database server or in Connector/C. In this case we will reclassify the bug (MDEV or CONC).
+
+Avoid screenshots!
+^^^^^^^^^^^^^^^^^^
+Use copy and paste instead. Screenshots create a lot more data volume and are often difficult to
+read on mobile devices. Typing program code from a screenshot is also an unnecessary effort.
+
+Keep it simple!
+^^^^^^^^^^^^^^^
+Scripts which are longer than 10 lines often contain code which is not relevant to the problem and increases
+the time to figure out the real problem. So try to keep it simple and focus on the real problem.
+
+The sane applies for database related components like tables, views and stored procedures. Avoid table definitions with
+hundred of columns if the problem can be reproduced with only 4 columns,
+
+Only report one problem in one bug report
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+If you have encountered two or more bugs which are not related, please file an issue for each of them.
+
+Crashes
+^^^^^^^
+If your application crashes, please also provide if possible a backtrace and output of the exception.
+
+Report bugs in English only!
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^

docs/source/conf.py

@@ -0,0 +1,100 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list 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
+import mariadb
+from typing import Sequence
+from datetime import datetime
+print(mariadb.__path__)
+sys.path.insert(0, os.path.abspath('../..'))
+sys.setrecursionlimit(1500)
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'MariaDB Connector/Python'
+copyright = '2019-%s MariaDB Corporation and Georg Richter' % datetime.now().year
+author = 'Georg Richter'
+
+# The full version, including alpha/beta/rc tags
+release = mariadb.__version__
+if len(mariadb.__version_info__) > 3:
+    release= release + "-" + mariadb.__version_info__[3]
+add_module_names= False
+
+
+# -- General configuration ---------------------------------------------------
+
+# 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.doctest', 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx',
+              'sphinx.ext.extlinks', 'sphinx_toolbox.collapse', 'myst_parser', 'sphinx_markdown_builder' ]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# 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 = []
+
+pygments_style = 'sphinx'
+
+master_doc = 'index'
+
+# Enable Markdown support via MyST-Parser
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
+
+# Optional: Enable MyST extensions (customize as needed)
+myst_enable_extensions = [
+    "colon_fence",
+    "deflist",
+    "html_admonition",
+    "html_image",
+    "linkify",
+    "substitution",
+    "tasklist",
+]
+
+
+# -- 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 = 'classic'
+
+# 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']
+html_show_sourcelink = False
+
+highlight_language = 'python'
+
+rst_epilog="""
+.. |MCP| replace:: MariaDB Connector/Python
+.. |MCC| replace:: MariaDB Connector/C
+.. |MCC_minversion| replace:: 3.3.1
+.. |DBAPI| replace:: DB API 2.0 (:PEP:`249`)
+.. |MCDP| replace:: `MariaDB Connector Download page <https://mariadb.com/downloads/connectors/>`__
+"""
+
+extlinks= {
+           'conpy' : ('https://jira.mariadb.org/browse/CONPY-%s', 'CONPY-%s'),
+           'PEP'   : ('https://peps.python.org/pep-%s', 'PEP-%s')
+          }