Module builder 

Re-exports

use crate::hir_ext; 🔒

use crate::render; 🔒

use crate::utils::git_source_url; 🔒

use crate::utils::is_safe_output_path; 🔒

use crate::utils::read_deployments; 🔒

use crate::utils::relative_source_path; 🔒

use crate::vocs; 🔒

use eyre::Result; 🔒

use foundry_compilers::compilers::solc::SOLC_EXTENSIONS; 🔒

use foundry_compilers::utils::source_files_iter; 🔒

use foundry_config::DocConfig; 🔒

use foundry_config::filter::expand_globs; 🔒

use foundry_config::filter::is_ignored_path; 🔒

use solar::config::CompilerStage; 🔒

use solar::sema::Compiler; 🔒

use std::collections::HashSet; 🔒

use std::fs; 🔒

use std::path::Path; 🔒

use std::path::PathBuf; 🔒

use std::time::Duration; 🔒

use std::time::Instant; 🔒

use rayon::prelude::*; 🔒

Structs

BuildStats

Summary stats produced by DocBuilder::build, surfaced to the user as progress feedback by forge doc.

DocBuilder

Build Solidity documentation for a project from natspec comments using solar.

Functions

update_manifest 🔒

The manifest is the ownership boundary: only previously generated pages can be pruned.

write_pages 🔒

Write successful pages, but do not change ownership or prune if a user source failed.

Type Aliases

RenderResult 🔒

Successful pages or the path of a user source whose renderer panicked.