Implementation:Vibrantlabsai Ragas Documentation Configuration

Knowledge Sources	Vibrantlabsai_Ragas
Domains	Documentation, Configuration, MkDocs
Last Updated	2026-02-12 00:00 GMT

Overview

The MkDocs documentation site configuration file that defines the structure, theme, plugins, and navigation for the Ragas documentation website.

Description

This YAML configuration file controls the entire Ragas documentation site built with MkDocs and the Material for MkDocs theme. It defines the site metadata, navigation hierarchy, theme customizations, markdown extensions, plugins, and extra assets. The configuration supports ReadTheDocs hosting (via the READTHEDOCS_CANONICAL_URL environment variable), Google Analytics tracking, and versioning through the Mike plugin.

The file is organized into the following major sections:

Site metadata: Name (Ragas), description, URL, and repository link.
Navigation (nav): A comprehensive multi-level navigation tree covering Get Started, Core Concepts, How-to Guides, References, and Community sections.
Theme configuration: Material for MkDocs with light/dark mode support, navigation features, and custom styling.
Markdown extensions: Code highlighting, admonitions, tabbed content, emoji support, math rendering, Mermaid diagrams, and snippet inclusion.
Plugins: Search, social cards, copy-to-llm, llmstxt, git revision dates, git committers, mkdocstrings (Python API docs), and glightbox.

Usage

This file is the primary configuration for building and serving the Ragas documentation. It is used by the make build-docs and make serve-docs commands to generate the documentation site. Developers modifying documentation structure, adding new pages, or configuring documentation plugins should edit this file.

Code Reference

Source Location

Repository: Vibrantlabsai_Ragas
File: mkdocs.yml

Configuration Overview

site_name: Ragas
site_description: Evaluation framework for your AI Application
site_url: !ENV READTHEDOCS_CANONICAL_URL
repo_name: vibrantlabsai/ragas
repo_url: https://github.com/vibrantlabsai/ragas
watch:
  - src

I/O Contract

Key Configuration Sections

Section	Purpose	Key Settings
site_name	Site identity	`Ragas` with description "Evaluation framework for your AI Application"
nav	Navigation tree	Five top-level sections: Get Started, Core Concepts, How-to Guides, References, Community
theme	Visual appearance	Material for MkDocs with light/dark/system color scheme toggle, custom logo and favicon
markdown_extensions	Content formatting	Code highlighting, admonitions, tabbed content, emoji, MathJax, Mermaid diagrams, snippets
plugins	Build plugins	search, social, copy-to-llm, llmstxt, git-revision-date-localized, git-committers, mkdocstrings, glightbox
extra_css	Custom styles	`extra/ragas-modern.css`
extra_javascript	External scripts	MathJax, header border effects, toggle functionality, Octolane analytics, CommonRoom analytics
validation	Link checking	Warnings for omitted files, absolute links, and unrecognized links

Navigation Structure

The documentation navigation is organized into five main sections:

Get Started

Page	File
Installation	`getstarted/install.md`
Quick Start	`getstarted/quickstart.md`
Tutorials (Prompt, RAG, Workflow, Agent)	`tutorials/*.md`

Core Concepts

Subsection	Coverage
Experimentation	Experiment management concepts
Datasets	Dataset handling concepts
Metrics	RAG metrics, Nvidia metrics, Agent metrics, NL comparison, SQL, General purpose, Summarization
Test Data Generation	RAG test generation and Agent/tool use test generation
Components	Prompt, Evaluation Sample, Evaluation Dataset

How-to Guides

Subsection	Topics
Customizations	Model customization, run config, caching, cancellation, LLM adapters, metric modification, test generation customization, optimizers
Applications	Prompt evaluation, cost analysis, multi-turn conversations, benchmarking, agent evaluation, RAG evaluation
CLI	RAG evaluation and improvement via command line
Integrations	Arize, LangSmith, Amazon Bedrock, Google Gemini, OCI Gen AI, AG-UI, Griptape, Haystack, LangChain, LangGraph, LlamaIndex, LlamaStack, R2R, Swarm
Migrations	v0.1 to v0.2, v0.3 to v0.4

References

Subsection	Coverage
Core	Prompt, LLMs, Embeddings, Tokenizers, RunConfig, Executor, Cache, Optimizers
Evaluation	Schemas, Metrics, evaluate(), aevaluate()
Testset Generation	Schemas, Graph, Transforms, Synthesizers, Generation
Integrations	Integration API reference

Plugin Details

copy-to-llm

- copy-to-llm:
    repo_url: "https://raw.githubusercontent.com/vibrantlabsai/ragas/main/docs"
    buttons:
      copy_page: true
      copy_markdown_link: false
      view_as_markdown: false
      open_in_chatgpt: true
      open_in_claude: true

Enables copying documentation pages directly to LLM chat interfaces (ChatGPT and Claude).

llmstxt

- llmstxt:
    markdown_description: |
      Ragas is an open-source evaluation framework for LLM applications...
    full_output: llms-full.txt
    sections:
      Getting Started:
        - getstarted/*.md
      Tutorials:
        - tutorials/*.md
      # ... additional sections

Generates an llms-full.txt file for LLM consumption, organized by documentation sections.

mkdocstrings

- mkdocstrings:
    handlers:
      python:
        paths: [src]
        options:
          docstring_style: numpy
          members_order: source
          separate_signature: true
          filters: ["!^_"]
          merge_init_into_class: true
          show_signature_annotations: true
          signature_crossrefs: true

Generates Python API documentation from source code in the src directory using NumPy-style docstrings. Private members (prefixed with underscore) are filtered out, and class __init__ methods are merged into class documentation.

Theme Configuration

The theme uses Material for MkDocs with the following notable features:

Color scheme: Supports automatic (system preference), light, and dark modes with a gold accent color (#bd8526).
Navigation features: Tabs, path breadcrumbs, instant navigation with prefetch/preview, section navigation, back-to-top button, and footer navigation.
Search enhancements: Search suggestions and result highlighting.
Custom directory: Additional theme overrides from docs/extra/overrides.

theme:
  name: material
  custom_dir: docs/extra/overrides
  logo: _static/imgs/ragas-logo.png
  favicon: _static/favicon.ico
  features:
    - navigation.tabs
    - navigation.instant
    - navigation.sections
    - search.suggest
    - search.highlight
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: "#bd8526"
      accent: "#bd8526"

Usage Examples

Building Documentation

# Build all documentation
make build-docs

# Serve documentation locally for development
make serve-docs

# Or directly with MkDocs
uv run mkdocs build
uv run mkdocs serve

Adding a New Documentation Page

# Add a new entry under the appropriate nav section in mkdocs.yml
nav:
  - "🛠️ How-to Guides":
      - Applications:
          - My New Guide: howtos/applications/my_new_guide.md

Related Pages

Environment:Vibrantlabsai_Ragas_Python_3_9_Core_Environment

Page Connections

Double-click a node to navigate. Hold to expand connections.

Principle

Implementation

Heuristic

Environment