Exocco is an Elixir port of Docco. The original quick-and-dirty, hundred-line-long, literate-programming-style documentation generator. It produces HTML that displays your comments alongside your code. Comments are passed through Markdown while code is passed through Pygments for syntax highlighting.
exocco
is a self contained elixir script. You can run it from the command line as follow:
exocco lib/foo.ex
...or
exocco lib/
This will generate linked HTML documentation for the named source files (or first level files in a directory), saving it into a folder.
To get more information about the available options, run:
exocco --help
To build Exocco:
Install Elixir...
grab the latest Exocco source...
git clone https://github.com/bitchef/exocco.git
and build the project:
cd exocco
mix deps.get
mix escript.build
Exocco is released under the MIT License.