sphinx-ultra 0.3.0

High-performance Rust-based Sphinx documentation builder for large codebases
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

//! Sphinx Ultra Builder
//!
//! A high-performance Rust-based Sphinx documentation builder designed for large codebases.

pub mod builder;
pub mod cache;
pub mod config;
pub mod directives;
pub mod document;
pub mod domains;
pub mod environment;
pub mod error;
pub mod extensions;
pub mod html_builder;
pub mod inventory;
pub mod matching;
pub mod parser;
pub mod python_config;
pub mod search;
pub mod template;
pub mod utils;
pub mod validation;

pub use builder::{BuildStats, SphinxBuilder};
pub use config::BuildConfig;
pub use directives::{
    validation::{
        DirectiveValidationResult, DirectiveValidationSystem, DirectiveValidator, ParsedDirective,
        ParsedRole, RoleValidationResult, RoleValidator,
        ValidationStatistics as DirectiveValidationStatistics,
    },
    Directive, DirectiveRegistry,
};
pub use document::Document;
pub use domains::{CrossReference, DomainObject, DomainRegistry, DomainValidator, ReferenceType};
pub use environment::BuildEnvironment;
pub use error::BuildError;
pub use extensions::{ExtensionLoader, SphinxApp, SphinxExtension};
pub use html_builder::HTMLBuilder;
pub use inventory::{InventoryFile, InventoryItem};
pub use parser::Parser;
pub use python_config::{ConfPyConfig, PythonConfigParser};
pub use search::SearchIndex;
pub use template::TemplateEngine;
pub use utils::{analyze_project, ProjectStats};
pub use validation::{
    ConstraintEngine, ConstraintValidator, ContentItem, FieldValue, ValidationConfig,
    ValidationContext, ValidationResult, ValidationRule, ValidationSeverity, Validator,
};