Crate sphinx_ultra 

Sphinx Ultra Builder

A high-performance Rust-based Sphinx documentation builder designed for large codebases.

Re-exports

pub use builder::BuildStats;

pub use builder::SphinxBuilder;

pub use config::BuildConfig;

pub use directives::validation::DirectiveValidationResult;

pub use directives::validation::DirectiveValidationSystem;

pub use directives::validation::DirectiveValidator;

pub use directives::validation::ParsedDirective;

pub use directives::validation::ParsedRole;

pub use directives::validation::RoleValidationResult;

pub use directives::validation::RoleValidator;

pub use directives::validation::ValidationStatistics as DirectiveValidationStatistics;

pub use directives::Directive;

pub use directives::DirectiveRegistry;

pub use document::Document;

pub use env::BuildEnvironment;

pub use error::BuildError;

pub use extensions::ExtensionLoader;

pub use extensions::SphinxApp;

pub use extensions::SphinxExtension;

pub use html_builder::HTMLBuilder;

pub use inventory::posix_join;

pub use inventory::InvObject;

pub use inventory::Inventory;

pub use inventory::InventoryFile;

pub use inventory::InventoryItem;

pub use parser::Parser;

pub use python_config::ConfPyConfig;

pub use python_config::PythonConfigParser;

pub use search::SearchIndex;

pub use template::TemplateEngine;

pub use utils::analyze_project;

pub use utils::ProjectStats;

pub use validation::ConstraintEngine;

pub use validation::ConstraintValidator;

pub use validation::ContentItem;

pub use validation::FieldValue;

pub use validation::ValidationConfig;

pub use validation::ValidationContext;

pub use validation::ValidationResult;

pub use validation::ValidationRule;

pub use validation::ValidationSeverity;

pub use validation::Validator;

Modules

builder

cache

config

directives

doctree

Typed doctree IR with docutils-equivalent node semantics (M2 wave 1).

document

env

Serialized BuildEnvironment — the persistent build-state record that mirrors Sphinx’s BuildEnvironment (environment/__init__.py), scoped to the fields this wave’s read-and-resolve phase populates (see docs/superpowers/plans/2026-08-31-m2-wave4-research-spec-sphinx-env-toctree-domains.md §1 for the full attribute-by-attribute mapping this struct is drawn from).

error

extensions

html_builder

intersphinx

sphinx.ext.intersphinx — cross-project references resolved through other projects’ objects.inv inventories.

inventory

objects.inv reader/writer — mirrors sphinx.util.inventory (Sphinx 9.1.0).

matching

Pattern matching utilities for file filtering.

parser

The build-path parser front end.

py

The Python domain (M2 wave 4.5).

python_config

rst

Recursive-descent RST parser with docutils-0.22.4 fidelity (M2 wave 1: block grammar only — the inline parser arrives in wave 2).

search

template

utils

validation

Content constraint validation system