ScyllaDB C# Driver Documentation

This directory contains the documentation for the ScyllaDB C# Driver, built with Sphinx and integrated with DocFX for API reference generation.

Prerequisites

• Python 3.10+
• Poetry - Python dependency management
• .NET SDK 8.0+ - For API documentation generation
• DocFX 2.77+ - C# API documentation tool

Quickstart

Install dependencies (first time only):

# Install poetry and docfx
make setupenv

Preview the documentation locally:

make preview

API Documentation

The API reference is generated with DocFX and available at:

• Local preview: http://localhost:5500/api-docs/
• Build output: _build/dirhtml/api-docs/

Note: If DocFX is not installed, the build will succeed but skip API documentation generation.