api-docs

API reference and SDK documentation for Waldur cloud management platform

About

This repository contains the source code for the Waldur API documentation. It is built using MkDocs and Material for MkDocs.

Local Development

Prerequisites

• Python 3.12+
• uv

Setup

Install the dependencies:

uv sync

Running the development server

Start the development server:

uv run mkdocs serve

The documentation will be available at http://127.0.0.1:8000/.

Building

To build the documentation, run:

uv run mkdocs build

The built site will be in the site directory.