Struct DocGenConfig 

#[non_exhaustive]
pub struct DocGenConfig {
    pub output_dir: PathBuf,
    pub json_output: String,
    pub separate_pages: bool,
    pub intro_message: Option<String>,
    pub index_title: Option<String>,
    pub contents_table: bool,
    pub separate_items: bool,
    pub generate_index: bool,
}

Configuration for documentation generation from pyproject.toml

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

output_dir: PathBuf

Output directory for generated documentation

json_output: String

Name of the JSON output file

separate_pages: bool

Generate separate .rst pages for each module (default: true)

intro_message: Option<String>

Custom intro message for index.rst (default: standard message, empty string to omit)

index_title: Option<String>

Custom title for index.rst (default: “{package_name} API Reference”, empty string to use “API Reference”)

contents_table: bool

Generate module contents tables (default: false)

separate_items: bool

Generate separate .rst pages for each class/function (default: false) When true, module pages show a summary table with links to individual item pages.

generate_index: bool

Generate index.rst file (default: true) Set to false to skip generating index.rst, useful when a hand-maintained index.rst exists.

Implementations

impl DocGenConfig

pub fn validate(&self) -> Result<()>

Validate configuration consistency

pub fn to_relative_posix_path(&self, base_dir: &Path) -> String

Convert output_dir to relative POSIX path for JSON serialization

Trait Implementations

impl Clone for DocGenConfig

fn clone(&self) -> DocGenConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocGenConfig

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

Formats the value using the given formatter.

impl Default for DocGenConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocGenConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DocGenConfig

fn eq(&self, other: &DocGenConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DocGenConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for DocGenConfig

impl StructuralPartialEq for DocGenConfig