CLI Interface

USAGE:    rhai-doc.exe [OPTIONS] [SUBCOMMAND]OPTIONS:    -a, --all              Generate documentation for all functions, including private ones    -c, --config <FILE>    Set the configuration file [default: rhai.toml]    -d, --dir <DIR>        Set the Rhai scripts (*.rhai) directory [default: .]    -D, --dest <DIR>       Set the destination for the documentation output [default: dist]    -h, --help             Print help information    -p, --pages <DIR>      Set the directory where MarkDown (*.md) pages files are located [default:                           pages]    -v, --verbose          Use multiple to set the level of verbosity: 1 = silent, 2 (default) =                           full, 3 = debug    -V, --version          Print version informationSUBCOMMANDS:    help    Print this message or the help of the given subcommand(s)    new     Generates a new configuration file

Installation

Install fromcrates.io

cargo install rhai-doc

Install from source

cargo install --path.

Configuration File

rhai-doc new

Example

version ="1.0"# version of this TOML filename ="My Rhai Project"# project namecolor = [246,119,2]# theme colorroot ="/docs/"# root URL for generated siteindex ="home.md"# this file becomes 'index.html`icon ="logo.svg"# project iconstylesheet ="my_stylesheet.css"# custom stylesheetcode_theme ="atom-one-light"# 'highlight.js' themecode_lang ="ts"# default language for code blocksextension ="rhai"# script extensiongoogle_analytics ="G-ABCDEF1234"# Google Analytics ID[[links]]# external link for 'Blog'name ="Blog"link ="https://example.com/blog"[[links]]# external link for 'Tools'name ="Tools"link ="https://example.com/tools"

Configuration options

Doc-Comments

/// This function calculates a **secret number**!////// Formula provided from this [link](https://secret_formula.com/calc_secret_number).////// # Scale Factor/// Uses a scale factor obtained by calling [`get_contribution_factor`].////// # Parameters/// `seed` - random seed to start the calculation////// # Returns/// The secret number!////// # Exceptions/// Throws when the seed is not positive.////// # Example/// ```/// let secret = calc_secret_number(42);/// ```fncalc_secret_number(seed){if seed <=0{        throw"the seed must be positive!";}let factor =get_contribution_factor(seed);// Some very complex code skipped ...// ...}/// This function is private and will not be included/// unless the `-a` flag is used.privatefnget_multiply_factor(){42}/// This function calculates a scale factor for use/// in the [`calc_secret_number`] function.fnget_contribution_factor(x){    x*get_multiply_factor()}

Syntax Highlighting

Inter-Script Links

MarkDown Pages

Features

License