[][src]Struct docgen::DocgenOptions

pub struct DocgenOptions {
    pub section_level_start: usize,
    pub include_private_fun: bool,
    pub include_specs: bool,
    pub specs_inlined: bool,
    pub include_impl: bool,
    pub toc_depth: usize,
    pub collapsed_sections: bool,
    pub output_directory: String,
    pub doc_path: Vec<String>,
    pub root_doc_templates: Vec<String>,
    pub references_file: Option<String>,
    pub include_dep_diagrams: bool,
    pub include_call_diagrams: bool,
}

Options passed into the documentation generator.

Fields

section_level_start: usize

The level where we start sectioning. Often markdown sections are rendered with unnecessary large section fonts, setting this value high reduces the size.

include_private_fun: bool

Whether to include private functions in the generated docs.

include_specs: bool

Whether to include specifications in the generated docs.

specs_inlined: bool

Whether to put specifications in the same section as a declaration or put them all into an independent section.

include_impl: bool

Whether to include Move implementations.

toc_depth: usize

Max depth to which sections are displayed in table-of-contents.

collapsed_sections: bool

Whether to use collapsed sections (

) for impl and specs

output_directory: String

In which directory to store output.

doc_path: Vec<String>

In which directories to look for references.

root_doc_templates: Vec<String>

A list of paths to files containing templates for root documents for the generated documentation.

A root document is a markdown file which contains placeholders for generated documentation content. It is also processed following the same rules than documentation comments in Move, including creation of cross-references and Move code highlighting.

A placeholder is a single line starting with a markdown quotation marker of the following form:

> {{move-include NAME_OF_MODULE_OR_SCRIPT}}
> {{move-toc}}
> {{move-index}}

These lines will be replaced by the generated content of the module or script, or a table of contents, respectively.

For a module or script which is included in the root document, no separate file is generated. References between the included and the standalone module/script content work transparently.

references_file: Option<String>

An optional file containing reference definitions. The content of this file will be added to each generated markdown doc.

include_dep_diagrams: bool

Whether to include dependency diagrams in the generated docs.

include_call_diagrams: bool

Whether to include call diagrams in the generated docs.

Trait Implementations

impl Clone for DocgenOptions[src]

impl Debug for DocgenOptions[src]

impl Default for DocgenOptions[src]

impl<'de> Deserialize<'de> for DocgenOptions where
    DocgenOptions: Default
[src]

impl Serialize for DocgenOptions[src]

Auto Trait Implementations

impl RefUnwindSafe for DocgenOptions

impl Send for DocgenOptions

impl Sync for DocgenOptions

impl Unpin for DocgenOptions

impl UnwindSafe for DocgenOptions

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

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

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Pointable for T

type Init = T

The type for initializers.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> TestOnlyHash for T where
    T: Serialize + ?Sized
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,