Skip to main content

sphinx_ultra/
lib.rs

1//! Sphinx Ultra Builder
2//!
3//! A high-performance Rust-based Sphinx documentation builder designed for large codebases.
4
5pub mod builder;
6pub mod cache;
7pub mod config;
8pub mod directives;
9pub mod doctree;
10pub mod document;
11pub mod env;
12pub mod error;
13pub mod extensions;
14pub mod html_builder;
15pub mod intersphinx;
16pub mod inventory;
17pub mod matching;
18pub mod parser;
19pub mod py;
20pub mod python_config;
21pub mod rst;
22pub mod search;
23pub mod template;
24pub mod utils;
25pub mod validation;
26
27pub use builder::{BuildStats, SphinxBuilder};
28pub use config::BuildConfig;
29pub use directives::{
30    validation::{
31        DirectiveValidationResult, DirectiveValidationSystem, DirectiveValidator, ParsedDirective,
32        ParsedRole, RoleValidationResult, RoleValidator,
33        ValidationStatistics as DirectiveValidationStatistics,
34    },
35    Directive, DirectiveRegistry,
36};
37pub use document::Document;
38pub use env::BuildEnvironment;
39pub use error::BuildError;
40pub use extensions::{ExtensionLoader, SphinxApp, SphinxExtension};
41pub use html_builder::HTMLBuilder;
42pub use inventory::{posix_join, InvObject, Inventory, InventoryFile, InventoryItem};
43pub use parser::Parser;
44pub use python_config::{ConfPyConfig, PythonConfigParser};
45pub use search::SearchIndex;
46pub use template::TemplateEngine;
47pub use utils::{analyze_project, ProjectStats};
48pub use validation::{
49    ConstraintEngine, ConstraintValidator, ContentItem, FieldValue, ValidationConfig,
50    ValidationContext, ValidationResult, ValidationRule, ValidationSeverity, Validator,
51};