Fundoc

-

Fundoc - the right way to generate documentation. A business feature in your project may be implemented in separated files and even in different technologies. Fundoc can merge all descriptions about business features and put in appropriate files.

Fundoc's main goals:

• Allow you to keep all your documentation along with your code. Separating documentation from code makes it harder to support.
• Use same versioning tools for your documentation as for your code. All versions of your documentation should match versions of source code otherwise we can't trust this documentation.
• A documentation generator should allow you to write your doc-fragments in different kinds of files like source code files (Rust, C++, TypeScript, Java, JavaScript, Ruby, Python, etc), specification files (Alloy, TLA+, etc), stylesheet files (CSS, SCSS, QT Stylesheets, etc), configs (JSON, TOML, YAML, etc).

Installation

You can install fundoc by executing this shell script:

bash curl -LSfs https://japaric.github.io/trust/install.sh | \ sh -s -- --git daynin/fundoc

If you're rust developer and you have had rust compiler installed, you can install fundoc from crates.io:

bash cargo install fundoc

Or manually download it from the releases page.

How to use

Just create a config file (read configuration docs here), start to write docstrings in your files according to fundoc's syntax, run fundoc to generate documentation: