⚡ Quick Start

Get started with Introligo in 5 minutes

Overview

This quick start guide will have you generating documentation in minutes.

Usage Examples

🚀 Basic Usage

Generate documentation from a YAML configuration

# Generate RST files in docs directory
python introligo.py config.yaml -o docs

# Preview what would be generated (dry run)
python introligo.py config.yaml -o docs --dry-run

# Use verbose output for debugging
python introligo.py config.yaml -o docs -v

📝 Simple Configuration File

Create your first YAML configuration

# config.yaml
index:
  title: "My Project Documentation"
  description: "Comprehensive documentation"

generate_index: true

modules:
  my_module:
    title: "My Module"
    module: "myproject.my_module"
    description: "A useful module"
    features:
      - "Feature 1"
      - "Feature 2"