Basic dialect docs (#92)

Author: vgvoleg

.github/workflows/docs.yml

@@ -0,0 +1,18 @@
+name: Deploy Sphinx documentation to Github Pages
+
+on:
+  push:
+    branches: [main, basic_dialect_docs] # branch to trigger deployment
+
+jobs:
+  pages:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+    - id: deployment
+      uses: sphinx-notes/pages@v3

.gitignore

@@ -133,3 +133,6 @@ dmypy.json
 
 # VSCode
 .vscode
+
+docs/.build/
+.DS_Store

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = .build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/README.md

@@ -0,0 +1,72 @@
+# YDB SQLAlchemy Documentation
+
+This directory contains the documentation for YDB SQLAlchemy dialect.
+
+## Building Documentation
+
+### Prerequisites
+
+1. Install Sphinx and required extensions:
+```bash
+pip install sphinx sphinx-rtd-theme sphinx-copybutton
+```
+
+### Building HTML Documentation
+
+1. Navigate to the docs directory:
+```bash
+cd docs
+```
+
+2. Build the documentation:
+```bash
+make html
+```
+
+3. Open the documentation in your browser:
+```bash
+open .build/html/index.html
+```
+
+### Building Other Formats
+
+- **PDF**: `make latexpdf` (requires LaTeX)
+- **EPUB**: `make epub`
+- **Man pages**: `make man`
+
+### Development
+
+When adding new documentation:
+
+1. Create `.rst` files in the appropriate directory
+2. Add them to the `toctree` in `index.rst`
+3. Rebuild with `make html`
+4. Check for warnings and fix them
+
+### Structure
+
+- `index.rst` - Main documentation page
+- `installation.rst` - Installation guide
+- `quickstart.rst` - Quick start guide
+- `connection.rst` - Connection configuration
+- `types.rst` - Data types documentation
+- `migrations.rst` - Alembic migrations guide
+- `api/` - API reference documentation
+- `conf.py` - Sphinx configuration
+- `_static/` - Static files (images, CSS, etc.)
+
+### Configuration
+
+The documentation is configured in `conf.py`. Key settings:
+
+- **Theme**: `sphinx_rtd_theme` (Read the Docs theme)
+- **Extensions**: autodoc, napoleon, intersphinx, copybutton
+- **Intersphinx**: Links to Python, SQLAlchemy, and Alembic docs
+
+### Troubleshooting
+
+**Sphinx not found**: Make sure Sphinx is installed in your virtual environment
+
+**Import errors**: Ensure the YDB SQLAlchemy package is installed in the same environment
+
+**Theme issues**: Install `sphinx-rtd-theme` if you get theme-related errors

docs/_static/logo.svg

@@ -0,0 +1,52 @@
+API Reference
+=============
+
+This section contains the complete API reference for YDB SQLAlchemy.
+
+Core Module
+-----------
+
+.. automodule:: ydb_sqlalchemy.sqlalchemy
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Types Module
+------------
+
+.. automodule:: ydb_sqlalchemy.sqlalchemy.types
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+DateTime Types
+--------------
+
+.. automodule:: ydb_sqlalchemy.sqlalchemy.datetime_types
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+JSON Types
+----------
+
+.. automodule:: ydb_sqlalchemy.sqlalchemy.json
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Compiler Module
+---------------
+
+.. automodule:: ydb_sqlalchemy.sqlalchemy.compiler
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+DML Operations
+--------------
+
+.. automodule:: ydb_sqlalchemy.sqlalchemy.dml
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/index.rst

@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- 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
+sys.path.insert(0, os.path.abspath('..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'YDB SQLAlchemy'
+copyright = '2025, Yandex'
+author = 'Yandex'
+
+# The short X.Y version
+version = '0.1'
+# The full version, including alpha/beta/rc tags
+release = '0.1.9'
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# 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.viewcode',
+    'sphinx.ext.todo',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.coverage',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.githubpages',
+    'sphinx_copybutton',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['.templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# 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 = ['.build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- 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 = 'sphinx_rtd_theme'
+
+html_theme_options = {
+    'fixed_sidebar': True,
+    'page_width': '1140px',
+    'show_related': True,
+    'show_powered_by': False
+}
+
+html_logo = '_static/logo.svg'
+html_favicon = '_static/logo.svg'
+
+html_show_sourcelink = False
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'ydb-sqlalchemy-doc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'ydb-sqlalchemy.tex', 'YDB SQLAlchemy Documentation',
+     'Yandex', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'ydb-sqlalchemy', 'YDB SQLAlchemy Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'ydb-sqlalchemy', 'YDB SQLAlchemy Documentation',
+     author, 'ydb-sqlalchemy', 'SQLAlchemy dialect for YDB (Yandex Database).',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
+
+autoclass_content = "both"
+autodoc_typehints = "both"
+autodoc_default_options = {
+    'undoc-members': True,
+    'member-order': 'bysource'
+}
+
+# -- Intersphinx configuration -----------------------------------------------
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+    'sqlalchemy': ('https://docs.sqlalchemy.org/en/20/', None),
+    'alembic': ('https://alembic.sqlalchemy.org/en/latest/', None),
+}
+
+# -- Copy button configuration --------------------------------------------
+
+copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
+copybutton_prompt_is_regexp = True