Skip to content
This repository has been archived by the owner on Aug 28, 2023. It is now read-only.
/ dadada Public archive

Artisanal Rust inlined code documentation renderer

Notifications You must be signed in to change notification settings

gnunicorn/dadada

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Crates.io License: MIT GitHub last commit Travis (.org)

Artisanal Rust inlined code documentation renderer

Here Screenshot / Action video

Install rust

For this to work you need to have rust installed. You can do this with sudo pacman -S rustup, or any other package manager.

Install

You can install it quite easily with cargo install dadada.

Usage

dadada will be installed as command line tool for you to run. Just specify the files you want to have rendered and it will do so. If you do not provide a target output file (--output / -o) the result will be printed to stdout.

The full list of cli arguments is:

Benjamin Kampmann <[email protected]>, Rui Vieira <[email protected]>
Artisanal Rust inlined code documentation renderer

USAGE:
    dadada [FLAGS] [OPTIONS] <FILE>...

FLAGS:
    -h, --help       Prints help information
        --no-css     Do not add CSS to output
        --no-js      Do not add Javascript to output
    -V, --version    Prints version information

OPTIONS:
    -o, --output <FILE>     target file to render to, stdout if not given
    -t, --title <String>    The HTML title to render

ARGS:
    <FILE>...    rust source files

An example to render all the rust files in your crate under target/dadada-output.html therefor would be: dadada --title "All my Code Example" -o target/dadada-output.html src/*.rs.

Help wanted!

Credits

This is inspired by docco by Bardadym Denis (sadly discontinued) and based off of the Rust tool dada by Rui Vieira

About

Artisanal Rust inlined code documentation renderer

Resources

Stars

Watchers

Forks

Packages

No packages published