Struct BuildConfig

pub struct BuildConfig {

    pub parallel_jobs: Option<usize>,
    pub max_cache_size_mb: usize,
    pub cache_expiration_hours: u64,
    pub output: OutputConfig,
    pub theme: ThemeConfig,
    pub extensions: Vec<String>,
    pub template_dirs: Vec<PathBuf>,
    pub static_dirs: Vec<PathBuf>,
    pub optimization: OptimizationConfig,
    pub project: String,
    pub version: Option<String>,
    pub release: Option<String>,
    pub copyright: Option<String>,
    pub language: Option<String>,
    pub root_doc: Option<String>,
    pub html_style: Vec<String>,
    pub html_css_files: Vec<String>,
    pub html_js_files: Vec<String>,
    pub html_static_path: Vec<PathBuf>,
    pub html_logo: Option<String>,
    pub html_favicon: Option<String>,
    pub html_title: Option<String>,
    pub html_short_title: Option<String>,
    pub html_show_copyright: Option<bool>,
    pub html_show_sphinx: Option<bool>,
    pub html_copy_source: Option<bool>,
    pub html_show_sourcelink: Option<bool>,
    pub html_sourcelink_suffix: Option<String>,
    pub html_use_index: Option<bool>,
    pub html_use_opensearch: Option<bool>,
    pub html_last_updated_fmt: Option<String>,
    pub templates_path: Vec<PathBuf>,
    pub fail_on_warning: bool,
    pub include_patterns: Vec<String>,
    pub exclude_patterns: Vec<String>,
}

Fields

parallel_jobs: Option<usize>

Number of parallel jobs to use (defaults to number of CPU cores)

max_cache_size_mb: usize

Maximum cache size in MB

cache_expiration_hours: u64

Cache expiration time in hours

output: OutputConfig

Output format configuration

theme: ThemeConfig

Theme configuration

extensions: Vec<String>

Extension configuration

template_dirs: Vec<PathBuf>

Custom template directories

static_dirs: Vec<PathBuf>

Static file directories

optimization: OptimizationConfig

Build optimization settings

project: String

Project name

version: Option<String>

Project version

release: Option<String>

Project release

copyright: Option<String>

Copyright notice

language: Option<String>

Language code

root_doc: Option<String>

Root document

html_style: Vec<String>

HTML theme style files

html_css_files: Vec<String>

HTML CSS files

html_js_files: Vec<String>

HTML JavaScript files

html_static_path: Vec<PathBuf>

HTML static paths

html_logo: Option<String>

HTML logo file

html_favicon: Option<String>

HTML favicon file

html_title: Option<String>

HTML title

html_short_title: Option<String>

HTML short title

html_show_copyright: Option<bool>

Show copyright in HTML

html_show_sphinx: Option<bool>

Show Sphinx attribution

html_copy_source: Option<bool>

Copy source files

html_show_sourcelink: Option<bool>

Show source links

html_sourcelink_suffix: Option<String>

Source link suffix

html_use_index: Option<bool>

Use index

html_use_opensearch: Option<bool>

Use OpenSearch

html_last_updated_fmt: Option<String>

Last updated format

templates_path: Vec<PathBuf>

Templates path

fail_on_warning: bool

Turn warnings into errors

include_patterns: Vec<String>

Glob-style patterns for file inclusion (Sphinx compatibility) Default: [“**”] (include all files)

exclude_patterns: Vec<String>

Glob-style patterns for file exclusion (Sphinx compatibility) Default: [] (exclude nothing) Exclusions have priority over inclusions

Implementations

impl BuildConfig

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self>

pub fn from_conf_py<P: AsRef<Path>>(conf_py_path: P) -> Result<Self>

Load configuration from a Sphinx conf.py file

pub fn auto_detect<P: AsRef<Path>>(source_dir: P) -> Result<Self>

Try to auto-detect and load configuration from various sources

pub fn save_to_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

Trait Implementations

impl Clone for BuildConfig

fn clone(&self) -> BuildConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BuildConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BuildConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BuildConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BuildConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.