Jump to content

Connect SuperML | Leeroopedia MCP: Equip your AI agents with best practices, code verification, and debugging knowledge. Powered by Leeroo — building Organizational Superintelligence. Contact us at founders@leeroo.com.

Implementation:Axolotl ai cloud Axolotl Quarto Docs Site Config

From Leeroopedia


Knowledge Sources
Domains Documentation, Build_System
Last Updated 2026-02-07 00:00 GMT

Overview

Quarto project configuration that defines the Axolotl documentation website structure, API reference generation, sidebar navigation, and build settings.

Description

The _quarto.yml file is the central configuration for the Axolotl documentation site built with Quarto. It defines: (1) pre-render scripts that auto-generate config reference and model example docs, (2) quartodoc API reference generation from Python docstrings organized into 16 sections (Core, CLI, Trainers, Model Loading, Mixins, Context Managers, Prompt Strategies, Kernels, Monkey Patches, Utils, Schemas, Integrations, Common, Models, Data Processing, Callbacks), (3) website metadata including title, favicon, Google Analytics, and social links, (4) a comprehensive sidebar with nested navigation covering Getting Started, Dataset Formats, Deployments, How-To Guides, Core Concepts, Advanced Features, and Troubleshooting, and (5) HTML format settings with darkly theme, MathJax, and markdown extensions.

Usage

This configuration is consumed by the Quarto build tool to render the documentation site. Contributors modify this file when adding new API modules, documentation pages, or restructuring the sidebar. The pre-render scripts (generate_config_docs.py and generate_examples_docs.py) execute automatically before each build.

Code Reference

Source Location

Signature

project:
  type: website
  pre-render:
   - docs/scripts/generate_config_docs.py
   - docs/scripts/generate_examples_docs.py

quartodoc:
  dir: docs/api
  package: axolotl
  title: API Reference
  parser: google
  sections:
    - title: Core          # 28 modules
    - title: CLI           # 22 modules
    - title: Trainers      # 7 modules
    # ... 13 more sections

website:
  title: "Axolotl"
  sidebar:
    contents:
      - Getting Started
      - Dataset Formats
      - Deployments
      - How To Guides
      - Core Concepts
      - Advanced Features
      - Troubleshooting

Import

# Not imported. Used by Quarto build system:
quarto render
quarto preview

I/O Contract

Inputs

Name Type Required Description
Python source code .py files Yes Source for quartodoc API reference extraction
.qmd documentation .qmd files Yes Quarto markdown pages referenced in sidebar
Pre-render scripts .py files Yes Auto-generation scripts for config/example docs

Outputs

Name Type Description
Documentation website HTML Static site at docs.axolotl.ai
API reference pages HTML Auto-generated from Python docstrings
Config reference .qmd Auto-generated config documentation

Usage Examples

Build Documentation Locally

# Preview the documentation site
quarto preview

# Render full static site
quarto render

# The pre-render scripts run automatically before build

Related Pages

Page Connections

Double-click a node to navigate. Hold to expand connections.
Principle
Implementation
Heuristic
Environment