https://github.com/creativcoder/cargo-docco

cargo docco generates literate programming style documentation pages from source code. Port of Jash Kenas' Docco in Rust.
https://github.com/creativcoder/cargo-docco

Last synced: about 2 months ago
JSON representation

cargo docco generates literate programming style documentation pages from source code. Port of Jash Kenas' Docco in Rust.

• Host: GitHub
• URL: https://github.com/creativcoder/cargo-docco
• Owner: creativcoder
• License: apache-2.0
• Created: 2020-11-06T06:46:00.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2020-11-06T11:09:37.000Z (about 4 years ago)
• Last Synced: 2024-10-31T11:52:16.820Z (2 months ago)
• Language: Rust
• Homepage:
• Size: 17.4 MB
• Stars: 8
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        


  

cargo docco

cargo docco generates literate programming style 

documentation pages.


[![Actions Status](https://github.com/creativcoder/cargo-docco/workflows/ci/badge.svg)](https://github.com/creativcoder/cargo-docco/actions)

[![crates.io](https://img.shields.io/crates/v/cargo-docco.svg)](https://crates.io/crates/cargo-docco)

[![license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/creativcoder/avrow/blob/master/LICENSE-MIT)

[![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/creativcoder/avrow/blob/master/LICENSE-APACHE)



## In action

![docco in action](assets/docco_cast.gif)

## Installation

```sh

$ cargo install cargo-docco

```

(Please check [`cargo`'s documentation](http://doc.crates.io/) to learn how `cargo install` works and how to set up your system so it finds binaries installed by `cargo`.)

## Usage

Generating documentation pages is as simple as providing cargo docco an input file via `-i` flag.

```

cargo docco -i source.rs [-o ]

```

When no output file is provided, cargo docco will generate an html file name

same as the source file name.

## CLI overview

```plain

> cargo docco -h

cargo-docco 0.1.0

Literate-style documentation generator from source code

USAGE:

    cargo docco [OPTIONS] -i 

FLAGS:

    -h, --help       Prints help information

    -V, --version    Prints version information

OPTIONS:

    -i          input source file

    -o         optional path to the generated output html file

```

## Supported languages

cargo-docco relies on [rocco](https://github.com/creativcoder/rocco). See "Supported languages" section for supported languages.

## Contribution

All kinds of contributions are welcome.

Questions can be asked in [issues](https://github.com/creativcoder/cargo-docco/issues).

To help us help you get pull requests merged quickly and smoothly, open an issue before submitted large changes. Please keep the contents of pull requests and commits short. Commit messages should include the intent of the commit.

## Support



[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/P5P71YZ0L)

## License

Dual licensed under either of Apache License, Version 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.