uiua-doc-gen

Crates.io	uiua-doc-gen
lib.rs	uiua-doc-gen
version	0.14.4
source	src
created_at	2024-11-11 05:23:12.4405
updated_at	2024-11-25 21:09:34.145394
description	Documentation generator for Uiua libraries
homepage
repository	https://github.com/ekgame/uiua-doc-gen
max_upload_size
id	1443465
size	490,023

Ernestas Kluonis (ekgame)

documentation

This is a command line tool to generate documentation from your Uiua libraries.

Demo image

This tool is still in development and has some limitations:

Only the declarations in lib.ua files are considered. If you import bindings from other files, they will not be displayed in this version.
There's only one theme available for the generated documentation.
Can not embed images yet.

You need to have Rust installed in your system.
Your library must have a single lib.ua file in the root of the project with all the declarations.

Install the package globally:
```
cargo install uiua-doc-gen
```
Open a terminal in the root of your Uiua project and run:
```
uiua-doc-gen --name project-name
```
The documentation will be generated in the doc-site folder.

The generated website is a static site, so you can host it on GitHub Pages. To do that, follow the steps in the uiua-doc-gen-action repository.

Commit count: 50