pub struct ConversionOptions<'a> {
pub input_path: &'a Path,
pub output_dir: &'a Path,
pub include_private: bool,
pub base_path: &'a str,
pub workspace_crates: &'a [String],
pub sidebarconfig_collapsed: bool,
pub sidebar_output: Option<&'a Path>,
pub sidebar_root_link: Option<&'a str>,
}Expand description
Options for converting rustdoc JSON to markdown.
Fields§
§input_path: &'a PathPath to the input rustdoc JSON file
output_dir: &'a PathDirectory where markdown files will be written
include_private: boolWhether to include private items in the output
base_path: &'a strBase path for links (e.g., “/docs/runtime/rust” for Docusaurus routing)
workspace_crates: &'a [String]List of workspace crate names - external crates in this list will use internal links
Whether to generate sidebar categories as collapsed
Custom path for the sidebar configuration file
URL for the ‘Go back’ link in root crate sidebars
Auto Trait Implementations§
impl<'a> Freeze for ConversionOptions<'a>
impl<'a> RefUnwindSafe for ConversionOptions<'a>
impl<'a> Send for ConversionOptions<'a>
impl<'a> Sync for ConversionOptions<'a>
impl<'a> Unpin for ConversionOptions<'a>
impl<'a> UnwindSafe for ConversionOptions<'a>
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