Skip to main content

ConfPyConfig

sphinx_ultra::python_config

Struct ConfPyConfig 

Source 
pub struct ConfPyConfig {
Show 121 fields
    pub project: Option<String>,
    pub version: Option<String>,
    pub release: Option<String>,
    pub copyright: Option<String>,
    pub author: Option<String>,
    pub extensions: Vec<String>,
    pub templates_path: Vec<String>,
    pub exclude_patterns: Vec<String>,
    pub include_patterns: Vec<String>,
    pub source_suffix: HashMap<String, String>,
    pub root_doc: Option<String>,
    pub language: Option<String>,
    pub locale_dirs: Vec<String>,
    pub gettext_compact: Option<bool>,
    pub html_theme: Option<String>,
    pub html_theme_options: HashMap<String, Value>,
    pub html_title: Option<String>,
    pub html_short_title: Option<String>,
    pub html_logo: Option<String>,
    pub html_favicon: Option<String>,
    pub html_css_files: Vec<String>,
    pub html_js_files: Vec<String>,
    pub html_static_path: Vec<String>,
    pub html_extra_path: Vec<String>,
    pub html_use_index: Option<bool>,
    pub html_split_index: Option<bool>,
    pub html_copy_source: Option<bool>,
    pub html_show_sourcelink: Option<bool>,
    pub html_sourcelink_suffix: Option<String>,
    pub html_use_opensearch: Option<String>,
    pub html_file_suffix: Option<String>,
    pub html_link_suffix: Option<String>,
    pub html_show_copyright: Option<bool>,
    pub html_show_sphinx: Option<bool>,
    pub html_context: HashMap<String, Value>,
    pub html_output_encoding: Option<String>,
    pub html_compact_lists: Option<bool>,
    pub html_secnumber_suffix: Option<String>,
    pub html_search_language: Option<String>,
    pub html_search_options: HashMap<String, Value>,
    pub html_search_scorer: Option<String>,
    pub html_scaled_image_link: Option<bool>,
    pub html_baseurl: Option<String>,
    pub html_codeblock_linenos_style: Option<String>,
    pub html_math_renderer: Option<String>,
    pub html_math_renderer_options: HashMap<String, Value>,
    pub latex_engine: Option<String>,
    pub latex_documents: Vec<(String, String, String, String, String)>,
    pub latex_logo: Option<String>,
    pub latex_appendices: Vec<String>,
    pub latex_domain_indices: Option<bool>,
    pub latex_show_pagerefs: Option<bool>,
    pub latex_show_urls: Option<String>,
    pub latex_use_latex_multicolumn: Option<bool>,
    pub latex_use_xindy: Option<bool>,
    pub latex_toplevel_sectioning: Option<String>,
    pub latex_docclass: HashMap<String, String>,
    pub latex_additional_files: Vec<String>,
    pub latex_elements: HashMap<String, String>,
    pub epub_title: Option<String>,
    pub epub_author: Option<String>,
    pub epub_language: Option<String>,
    pub epub_publisher: Option<String>,
    pub epub_copyright: Option<String>,
    pub epub_identifier: Option<String>,
    pub epub_scheme: Option<String>,
    pub epub_uid: Option<String>,
    pub epub_cover: Option<(String, String)>,
    pub epub_css_files: Vec<String>,
    pub epub_pre_files: Vec<(String, String)>,
    pub epub_post_files: Vec<(String, String)>,
    pub epub_exclude_files: Vec<String>,
    pub epub_tocdepth: Option<i32>,
    pub epub_tocdup: Option<bool>,
    pub epub_tocscope: Option<String>,
    pub epub_fix_images: Option<bool>,
    pub epub_max_image_width: Option<i32>,
    pub epub_show_urls: Option<String>,
    pub epub_use_index: Option<bool>,
    pub epub_description: Option<String>,
    pub epub_contributor: Option<String>,
    pub epub_writing_mode: Option<String>,
    pub extension_configs: HashMap<String, HashMap<String, Value>>,
    pub needs_sphinx: Option<String>,
    pub needs_extensions: HashMap<String, String>,
    pub manpages_url: Option<String>,
    pub nitpicky: Option<bool>,
    pub nitpick_ignore: Vec<(String, String)>,
    pub nitpick_ignore_regex: Vec<(String, String)>,
    pub numfig: Option<bool>,
    pub numfig_format: HashMap<String, String>,
    pub numfig_secnum_depth: Option<i32>,
    pub math_number_all: Option<bool>,
    pub math_eqref_format: Option<String>,
    pub math_numfig: Option<bool>,
    pub tls_verify: Option<bool>,
    pub tls_cacerts: Option<TlsCacerts>,
    pub user_agent: Option<String>,
    pub maximum_signature_line_length: Option<i64>,
    pub python_maximum_signature_line_length: Option<i64>,
    pub python_trailing_comma_in_multi_line_signatures: Option<bool>,
    pub python_display_short_literal_types: Option<bool>,
    pub python_use_unqualified_type_names: Option<bool>,
    pub toc_object_entries: Option<bool>,
    pub toc_object_entries_show_parents: Option<String>,
    pub source_encoding: Option<String>,
    pub confval_type_mismatches: Vec<(String, String)>,
    pub add_function_parentheses: Option<bool>,
    pub add_module_names: Option<bool>,
    pub strip_signature_backslash: Option<bool>,
    pub modindex_common_prefix: Vec<String>,
    pub intersphinx_mapping: Value,
    pub intersphinx_disabled_reftypes: Option<Vec<String>>,
    pub intersphinx_resolve_self: Option<String>,
    pub intersphinx_cache_limit: Option<i64>,
    pub intersphinx_timeout: Option<f64>,
    pub gettext_uuid: Option<bool>,
    pub gettext_location: Option<bool>,
    pub gettext_auto_build: Option<bool>,
    pub gettext_additional_targets: Vec<String>,
    pub custom_configs: HashMap<String, Value>,

}
Expand description

Represents a parsed conf.py configuration

Fields§

§project: Option<String>§version: Option<String>§release: Option<String>§copyright: Option<String>§author: Option<String>§extensions: Vec<String>§templates_path: Vec<String>§exclude_patterns: Vec<String>§include_patterns: Vec<String>§source_suffix: HashMap<String, String>§root_doc: Option<String>§language: Option<String>§locale_dirs: Vec<String>§gettext_compact: Option<bool>§html_theme: Option<String>§html_theme_options: HashMap<String, Value>§html_title: Option<String>§html_short_title: Option<String>§html_favicon: Option<String>§html_css_files: Vec<String>§html_js_files: Vec<String>§html_static_path: Vec<String>§html_extra_path: Vec<String>§html_use_index: Option<bool>§html_split_index: Option<bool>§html_copy_source: Option<bool>§html_show_sourcelink: Option<bool>§html_sourcelink_suffix: Option<String>§html_use_opensearch: Option<String>§html_file_suffix: Option<String>§html_link_suffix: Option<String>§html_show_copyright: Option<bool>§html_show_sphinx: Option<bool>§html_context: HashMap<String, Value>§html_output_encoding: Option<String>§html_compact_lists: Option<bool>§html_secnumber_suffix: Option<String>§html_search_language: Option<String>§html_search_options: HashMap<String, Value>§html_search_scorer: Option<String>§html_scaled_image_link: Option<bool>§html_baseurl: Option<String>§html_codeblock_linenos_style: Option<String>§html_math_renderer: Option<String>§html_math_renderer_options: HashMap<String, Value>§latex_engine: Option<String>§latex_documents: Vec<(String, String, String, String, String)>§latex_appendices: Vec<String>§latex_domain_indices: Option<bool>§latex_show_pagerefs: Option<bool>§latex_show_urls: Option<String>§latex_use_latex_multicolumn: Option<bool>§latex_use_xindy: Option<bool>§latex_toplevel_sectioning: Option<String>§latex_docclass: HashMap<String, String>§latex_additional_files: Vec<String>§latex_elements: HashMap<String, String>§epub_title: Option<String>§epub_author: Option<String>§epub_language: Option<String>§epub_publisher: Option<String>§epub_copyright: Option<String>§epub_identifier: Option<String>§epub_scheme: Option<String>§epub_uid: Option<String>§epub_cover: Option<(String, String)>§epub_css_files: Vec<String>§epub_pre_files: Vec<(String, String)>§epub_post_files: Vec<(String, String)>§epub_exclude_files: Vec<String>§epub_tocdepth: Option<i32>§epub_tocdup: Option<bool>§epub_tocscope: Option<String>§epub_fix_images: Option<bool>§epub_max_image_width: Option<i32>§epub_show_urls: Option<String>§epub_use_index: Option<bool>§epub_description: Option<String>§epub_contributor: Option<String>§epub_writing_mode: Option<String>§extension_configs: HashMap<String, HashMap<String, Value>>§needs_sphinx: Option<String>§needs_extensions: HashMap<String, String>§manpages_url: Option<String>§nitpicky: Option<bool>§nitpick_ignore: Vec<(String, String)>§nitpick_ignore_regex: Vec<(String, String)>§numfig: Option<bool>§numfig_format: HashMap<String, String>§numfig_secnum_depth: Option<i32>§math_number_all: Option<bool>§math_eqref_format: Option<String>§math_numfig: Option<bool>§tls_verify: Option<bool>§tls_cacerts: Option<TlsCacerts>§user_agent: Option<String>§maximum_signature_line_length: Option<i64>§python_maximum_signature_line_length: Option<i64>§python_trailing_comma_in_multi_line_signatures: Option<bool>§python_display_short_literal_types: Option<bool>§python_use_unqualified_type_names: Option<bool>§toc_object_entries: Option<bool>§toc_object_entries_show_parents: Option<String>§source_encoding: Option<String>

source_encoding as written, None when conf.py said nothing.

§confval_type_mismatches: Vec<(String, String)>

(key, python type name) for the int | None keys whose conf.py value is neither an int nor None — what sphinx’s check_confval_types warns about (see crate::config::BuildConfig::confval_type_mismatches).

§add_function_parentheses: Option<bool>§add_module_names: Option<bool>§strip_signature_backslash: Option<bool>§modindex_common_prefix: Vec<String>§intersphinx_mapping: Value

The raw intersphinx_mapping value, exactly as conf.py wrote it. Normalisation and validation happen in ConfPyConfig::to_build_config, where a failure can abort configuration the way Sphinx’s ConfigError aborts the build.

§intersphinx_disabled_reftypes: Option<Vec<String>>§intersphinx_resolve_self: Option<String>§intersphinx_cache_limit: Option<i64>§intersphinx_timeout: Option<f64>§gettext_uuid: Option<bool>§gettext_location: Option<bool>§gettext_auto_build: Option<bool>§gettext_additional_targets: Vec<String>§custom_configs: HashMap<String, Value>

Implementations§

Source§

impl ConfPyConfig

Source

pub fn to_build_config(&self) -> Result<BuildConfig>

Convert conf.py configuration to BuildConfig.

Fails only where Sphinx itself raises ConfigError at config-inited — today that is intersphinx_mapping validation (ext/intersphinx/_load.py:131-136), which aborts the build before it reads a single document.

Trait Implementations§

Source§

impl Clone for ConfPyConfig

Source§

fn clone(&self) -> ConfPyConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConfPyConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ConfPyConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ConfPyConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ConfPyConfig

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.