Struct HTMLBuilder 

pub struct HTMLBuilder {

    pub name: String,
    pub format: String,
    pub epilog: String,
    pub out_suffix: String,
    pub link_suffix: String,
    pub searchindex_filename: String,
    pub allow_parallel: bool,
    pub copysource: bool,
    pub use_index: bool,
    pub embedded: bool,
    pub search: bool,
    pub download_support: bool,
    pub supported_image_types: Vec<String>,
    pub supported_remote_images: bool,
    pub supported_data_uri_images: bool,
    pub outdir: PathBuf,
    pub srcdir: PathBuf,
    pub confdir: PathBuf,
    pub static_dir: PathBuf,
    pub sources_dir: PathBuf,
    pub downloads_dir: PathBuf,
    pub images_dir: PathBuf,
    pub config: BuildConfig,
    pub current_docname: String,
    pub secnumbers: HashMap<String, Vec<u32>>,
    pub imgpath: String,
    pub dlpath: String,
    pub css_files: Vec<CSSFile>,
    pub js_files: Vec<JSFile>,
    pub template_engine: TemplateEngine,
    pub global_context: Map<String, Value>,
    pub relations: HashMap<String, DocumentRelation>,
    pub domain_indices: Vec<DomainIndex>,
}

HTML Builder that mirrors Sphinx’s StandaloneHTMLBuilder

Fields

name: String

format: String

epilog: String

out_suffix: String

link_suffix: String

searchindex_filename: String

allow_parallel: bool

copysource: bool

use_index: bool

embedded: bool

search: bool

download_support: bool

supported_image_types: Vec<String>

supported_remote_images: bool

supported_data_uri_images: bool

outdir: PathBuf

srcdir: PathBuf

confdir: PathBuf

static_dir: PathBuf

sources_dir: PathBuf

downloads_dir: PathBuf

images_dir: PathBuf

config: BuildConfig

current_docname: String

secnumbers: HashMap<String, Vec<u32>>

imgpath: String

dlpath: String

css_files: Vec<CSSFile>

js_files: Vec<JSFile>

template_engine: TemplateEngine

global_context: Map<String, Value>

Global template context

relations: HashMap<String, DocumentRelation>

domain_indices: Vec<DomainIndex>

Implementations

impl HTMLBuilder

pub fn new( config: BuildConfig, srcdir: PathBuf, outdir: PathBuf, ) -> Result<Self>

pub async fn init(&mut self) -> Result<()>

Initialize the builder (mirrors Sphinx’s init method)

pub async fn write_doc( &mut self, docname: &str, doctree: &Document, ) -> Result<()>

Write a single document (mirrors Sphinx’s write_doc)

pub fn get_target_uri(&self, docname: &str) -> String

Get target URI for a document: quote(docname) + self.link_suffix, as StandaloneHTMLBuilder.get_target_uri percent-encodes it.

pub async fn gen_indices(&mut self) -> Result<()>

Generate indices (mirrors Sphinx’s gen_indices)

pub async fn copy_static_files(&self) -> Result<()>

Copy static files (mirrors Sphinx’s copy_static_files)

pub async fn copy_image_files( &self, images: &HashMap<String, String>, ) -> Result<()>

Copy image files

pub async fn copy_download_files( &self, downloads: &HashMap<String, String>, ) -> Result<()>

Copy download files

pub async fn dump_search_index(&self, search_index: &SearchIndex) -> Result<()>

Dump search index

pub async fn write_build_info(&self) -> Result<()>

Write build info file

pub async fn dump_object_inventory( &self, search_index: &SearchIndex, ) -> Result<()>

Write the direct builder’s inventory from the same search-index object records used by its Sphinx-shaped JSON output. The full builder has richer environment registries, but both paths use InventoryFile for the wire format, the std domain’s preseeded labels, and the one priority table the search index applies to the same objects.

pub async fn finish(&mut self, search_index: &SearchIndex) -> Result<()>

Finish the build process

Trait Implementations

impl Debug for HTMLBuilder

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

Formats the value using the given formatter.