Implementation:Truera Trulens MkDocs Config

Knowledge Sources	Truera_Trulens
Domains	Documentation
Last Updated	2026-02-14 08:00 GMT

Overview

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

Description

The mkdocs.yml file at the repository root configures the MkDocs static site generator with the Material for MkDocs theme to build the TruLens documentation site. This is a configuration file, not executable code. It defines the complete documentation build pipeline including content organization, rendering extensions, API reference generation, and deployment settings.

The configuration is organized into several major sections:

Site Metadata:

Site name is set to "TruLens" with a description of "Evaluate and track LLM applications. Explain Deep Neural Nets."
Links to the GitHub repository at truera/trulens.

Markdown Extensions:

admonition -- Callout blocks for warnings, notes, and tips.
toc -- Table of contents with permalink support.
pymdownx.magiclink -- Automatic URL linking.
pymdownx.superfences -- Enhanced code fences.
pymdownx.tabbed -- Tabbed content blocks with alternate style.
pymdownx.details -- Collapsible detail sections.
markdown_include.include -- File inclusion with base path set to docs.
attr_list and tables -- HTML attribute lists and table support.

Plugins:

blog -- Blog post support.
include-markdown -- Markdown file inclusion with configurable indentation and URL rewriting.
search -- Site-wide search functionality.
gen-files -- Auto-generates reference pages via docs/gen_ref_pages.py.
literate-nav -- Navigation from SUMMARY.md files.
mkdocs-jupyter -- Renders Jupyter notebooks (.ipynb) as documentation pages.
mkdocstrings -- Generates API reference documentation from Python docstrings using Google-style docstring parsing, with cross-reference imports from Python, NumPy, LangChain, Pandas, Pydantic, and SQLAlchemy documentation.
redirects -- Maps old URLs to new locations for backward compatibility.

Theme Configuration:

Uses the Material theme with automatic, light (trulens-light), and dark (slate) palette toggles.
Custom directory at docs/overrides/.
Features include navigation tabs, sections, top-of-page button, search suggestions and highlighting, table of contents following, and code copy buttons.

Navigation Structure: The documentation is organized into the following top-level sections:

Home -- Landing page.
Getting Started -- Quickstarts, core concepts (Metrics, RAG Triad, Honest/Harmless/Helpful Evals), and viewing results.
Component Guides -- Instrumentation (LangChain, LangGraph, LlamaIndex), logging (Postgres, Snowflake), evaluation (metrics, selectors, aggregation, running metrics, test case generation), runtime evaluation (inline evals, guardrails), and migration guides.
API Reference -- Auto-generated from source.
Cookbook -- Recipes and examples.
OpenTelemetry -- OTEL integration documentation.
Contributing -- Development setup, design, release policies, standards, tech debt, optional packages, database schema, and release history.
Blog -- Blog posts.

Extras:

Google Analytics tracking (G-VE9D0QFFKD).
Custom CSS (stylesheets/extra.css).
MathJax support for mathematical notation rendering.
TableSort JavaScript for sortable tables.

Usage

This file is consumed by MkDocs to build and serve the TruLens documentation website. Developers use mkdocs serve for local preview and mkdocs build for generating the static site. The watch directive ensures changes in the src directory trigger live reloads during development.

Code Reference

Source Location

Repository: Truera_Trulens
File: mkdocs.yml
Lines: 1-313

Structure Overview

site_name: TruLens
site_description: Evaluate and track LLM applications. Explain Deep Neural Nets.
repo_name: truera/trulens
repo_url: https://github.com/truera/trulens

markdown_extensions:
  - admonition
  - toc: { permalink: true }
  - pymdownx.magiclink
  - pymdownx.superfences
  - pymdownx.tabbed: { alternate_style: true }
  - pymdownx.details
  - markdown_include.include: { base_path: docs }
  - attr_list
  - tables

plugins:
  - blog
  - include-markdown
  - search
  - gen-files
  - literate-nav
  - mkdocs-jupyter
  - mkdocstrings  # Python docstring handler with Google style
  - redirects

theme:
  name: material
  palette:  # auto / light (trulens-light) / dark (slate)
  features:
    - navigation.tabs
    - navigation.sections
    - search.suggest
    - content.code.copy

nav:
  - Home
  - Getting Started
  - Component Guides
  - API Reference
  - Cookbook
  - OpenTelemetry
  - Contributing
  - Blog

Key Configuration Sections

mkdocstrings Python Handler

The API reference generation is configured with paths to all TruLens sub-packages:

Source Path	Description
`src/core`	Core TruLens library.
`src/feedback`	Feedback/metric definitions.
`src/dashboard`	Dashboard UI components.
`src/benchmark`	Benchmarking utilities.
`src/apps/langchain`	LangChain integration.
`src/apps/llamaindex`	LlamaIndex integration.
`src/apps/nemo`	NeMo integration.
`src/providers/bedrock`	AWS Bedrock provider.
`src/providers/cortex`	Snowflake Cortex provider.
`src/providers/huggingface`	HuggingFace provider.
`src/providers/langchain`	LangChain provider.
`src/providers/litellm`	LiteLLM provider.
`src/providers/openai`	OpenAI provider.
`src/connectors/snowflake`	Snowflake connector.

Redirect Mappings

The configuration includes backward-compatible URL redirects from legacy documentation paths (e.g., trulens/install.md to getting_started/install.md) to maintain external link stability.

Related Pages

Environment:Truera_Trulens_Python_Core_Environment

Page Connections

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

Principle

Implementation

Heuristic

Environment