pub struct DocConfig {
pub input: PathBuf,
pub output: PathBuf,
pub base_url: Option<String>,
pub format: OutputFormat,
pub output_mode: OutputMode,
pub example_depth: usize,
pub generate_index: bool,
}Expand description
Configuration for documentation generation.
Fields§
§input: PathBufInput path (directory or single file)
output: PathBufOutput directory for markdown files (or single file path for SinglePage mode)
base_url: Option<String>Base URL for cross-type links (e.g., “/docs/types”)
format: OutputFormatOutput format
output_mode: OutputModeOutput mode (multi-page or single-page)
example_depth: usizeMaximum depth for TypeRef expansion in examples
generate_index: boolWhether to generate index files
Trait Implementations§
Auto Trait Implementations§
impl Freeze for DocConfig
impl RefUnwindSafe for DocConfig
impl Send for DocConfig
impl Sync for DocConfig
impl Unpin for DocConfig
impl UnwindSafe for DocConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more