Struct BuildEnvironment

pub struct BuildEnvironment {

    pub config: BuildConfig,
    pub domains: HashMap<String, Domain>,
    pub found_docs: Vec<String>,
    pub all_docs: HashMap<String, f64>,
    pub dependencies: HashMap<String, HashSet<PathBuf>>,
    pub included: HashMap<PathBuf, HashSet<String>>,
    pub temp_data: HashMap<String, Value>,
    pub ref_context: HashMap<String, Value>,
    pub toctree_includes: HashMap<String, Vec<String>>,
    pub files_to_rebuild: HashMap<String, HashSet<String>>,
    pub glob_toctrees: HashSet<String>,
    pub reread_always: HashSet<String>,
    pub metadata: HashMap<String, HashMap<String, String>>,
    pub titles: HashMap<String, String>,
    pub longtitles: HashMap<String, String>,
    pub tocs: HashMap<String, String>,
    pub toc_secnumbers: HashMap<String, HashMap<String, Vec<u32>>>,
    pub toc_fignumbers: HashMap<String, HashMap<String, HashMap<String, Vec<u32>>>>,
    pub toc_num_entries: HashMap<String, usize>,
    pub dlfiles: HashMap<String, (Option<String>, String)>,
    pub images: HashMap<String, String>,
}

Build environment that mirrors Sphinx’s BuildEnvironment

Fields

config: BuildConfig

domains: HashMap<String, Domain>

found_docs: Vec<String>

all_docs: HashMap<String, f64>

dependencies: HashMap<String, HashSet<PathBuf>>

included: HashMap<PathBuf, HashSet<String>>

temp_data: HashMap<String, Value>

ref_context: HashMap<String, Value>

toctree_includes: HashMap<String, Vec<String>>

files_to_rebuild: HashMap<String, HashSet<String>>

glob_toctrees: HashSet<String>

reread_always: HashSet<String>

metadata: HashMap<String, HashMap<String, String>>

titles: HashMap<String, String>

longtitles: HashMap<String, String>

tocs: HashMap<String, String>

toc_secnumbers: HashMap<String, HashMap<String, Vec<u32>>>

toc_fignumbers: HashMap<String, HashMap<String, HashMap<String, Vec<u32>>>>

toc_num_entries: HashMap<String, usize>

dlfiles: HashMap<String, (Option<String>, String)>

images: HashMap<String, String>

Implementations

impl BuildEnvironment

pub fn new(config: BuildConfig) -> Self

pub fn add_document(&mut self, docname: String, mtime: f64)

Add a document to the environment

pub fn doc2path(&self, docname: &str) -> PathBuf

Get document path from docname

pub fn collect_relations( &self, ) -> HashMap<String, (Option<String>, Option<String>, Option<String>)>

Collect relations between documents

pub fn doc_needs_update(&self, docname: &str, source_path: &PathBuf) -> bool

Check if document needs to be updated

pub fn update_domain_object( &mut self, domain_name: &str, obj_type: &str, object: DomainObject, )

Update domain object

pub fn get_all_objects(&self) -> Vec<&DomainObject>

Get all objects from all domains

Trait Implementations

impl Clone for BuildEnvironment

fn clone(&self) -> BuildEnvironment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuildEnvironment

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

Formats the value using the given formatter.