Skip to content

README.md

Latest commit

 

History

History
52 lines (35 loc) · 1.47 KB

README.md

File metadata and controls

52 lines (35 loc) · 1.47 KB

Documentation

This directory contains the source files for the Ably Python SDK documentation, built using MkDocs and Material for MkDocs.

Building the Documentation

Prerequisites

  • Python 3.12 or higher (documentation tools require Python 3.12+)
  • Install documentation dependencies: uv sync --extra docs

Build HTML Documentation

# Build the documentation
uv run mkdocs build

# The generated HTML will be in the site/ directory

Serve Documentation Locally

# Start a local development server
uv run mkdocs serve

# Open http://127.0.0.1:8000/ in your browser

The development server automatically rebuilds the documentation when you make changes to the source files.

Documentation Structure

  • docs/ - Documentation source files (Markdown)
    • index.md - Home page
    • api/ - API reference documentation
  • mkdocs.yml - MkDocs configuration
  • site/ - Generated HTML documentation (gitignored)

How It Works

The documentation uses mkdocstrings to automatically generate API documentation from Python docstrings. The special ::: syntax in Markdown files tells mkdocstrings to extract and render documentation from Python modules:

::: ably.rest.rest.AblyRest

This automatically generates formatted documentation including:

  • Class and method signatures
  • Docstrings
  • Type hints
  • Parameters and return types