Struct SphinxEnvironment

pub struct SphinxEnvironment {
    pub docname_to_path: HashMap<String, PathBuf>,
    pub path_to_docname: HashMap<PathBuf, String>,
    pub dependencies: HashMap<String, Vec<String>>,
    pub included: HashMap<String, Vec<String>>,
    pub toctree_includes: HashMap<String, Vec<String>>,
    pub files_to_rebuild: HashMap<String, Vec<String>>,
    pub glob_toctrees: Vec<String>,
    pub numbered_toctrees: Vec<String>,
    pub metadata: HashMap<String, HashMap<String, String>>,
}

Sphinx build environment

Fields

docname_to_path: HashMap<String, PathBuf>

path_to_docname: HashMap<PathBuf, String>

dependencies: HashMap<String, Vec<String>>

included: HashMap<String, Vec<String>>

toctree_includes: HashMap<String, Vec<String>>

files_to_rebuild: HashMap<String, Vec<String>>

glob_toctrees: Vec<String>

numbered_toctrees: Vec<String>

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

Implementations

impl SphinxEnvironment

pub fn new() -> Self

Create a new Sphinx environment

pub fn add_document(&mut self, docname: String, path: PathBuf)

Add a document to the environment

pub fn get_doc_path(&self, docname: &str) -> Option<&PathBuf>

Get document path by name

pub fn get_docname(&self, path: &PathBuf) -> Option<&String>

Get document name by path

pub fn add_dependency(&mut self, docname: String, dependency: String)

Add dependency between documents

pub fn get_dependencies(&self, docname: &str) -> Option<&Vec<String>>

Get dependencies for a document

pub fn add_metadata(&mut self, docname: String, key: String, value: String)

Add metadata for a document

pub fn get_metadata(&self, docname: &str) -> Option<&HashMap<String, String>>

Get metadata for a document

Trait Implementations

impl Debug for SphinxEnvironment

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

Formats the value using the given formatter.

impl Default for SphinxEnvironment

fn default() -> Self

Returns the “default value” for a type.