Skip to main content

docs_render_sidebar

Function docs_render_sidebar 

Source
pub fn docs_render_sidebar(
    sidebar_template_html: &str,
    sidebar_item_template_html: &str,
    sidebar_group_template_html: &str,
    sidebar_title: &str,
    nav_entries: &[DocsNavEntry],
    current_page_html_rel: &str,
) -> Option<String>
Expand description

Performs docs render sidebar.

§Parameters

§Returns

Returns Some when crate::docs::docs_render_sidebar can produce a value and None otherwise.

§Performance

Performance is proportional to the size of the supplied inputs and any parsed or loaded data consumed by crate::docs::docs_render_sidebar.

§Examples

ⓘ
let _result = pharos_runtime_docs::docs::docs_render_sidebar(todo!(), todo!(), todo!(), todo!(), todo!());
  • crate::docs for adjacent helpers that share the same runtime surface.