Skip to content

Instantly share code, notes, and snippets.

@tonini
Created October 17, 2014 07:46
Show Gist options
  • Save tonini/6d0a396db7ee11852edb to your computer and use it in GitHub Desktop.
Save tonini/6d0a396db7ee11852edb to your computer and use it in GitHub Desktop.
$ ../ex_doc/bin/ex_doc
Too few arguments.
Usage:
ex_doc PROJECT VERSION BEAMS [OPTIONS]
Examples:
ex_doc "Dynamo" "0.8.0" "_build/shared/lib/dynamo/ebin" -u "https://github.com/elixir-lang/dynamo"
Options:
PROJECT Project name
VERSION Version number
BEAMS Path to compiled beam files
-o, --output Path to output docs, default: docs
--readme Path to README.md file to generate a project README, default: nil
-f, --formatter Docs formatter to use; default: html
-c, --config Path to the formatter's config file
-r, --source-root Path to the source code root, default: .
-u, --source-url URL to the source code
--source-ref Branch/commit/tag used for source link inference, default: master
-m, --main The main, entry-point module in docs
-p --homepage-url URL to link to for the site name
## Source linking
ExDoc by default provide links to the source code implementation as
long as `--source-url` or `--source-url-pattern` is provided. If you
provide `--source-url`, ExDoc will inflect the url pattern automatically
for GitHub and Bitbucket URLs. For example:
--source-url "https://github.com/elixir-lang/dynamo"
Will be inflected as:
https://github.com/elixir-lang/dynamo/blob/master/%{path}#L%{line}
To specify a particular branch or commit, use the `--source-ref` option:
--source-url "https://github.com/elixir-lang/dynamo" --source-ref "v1.0"
will result in the following URL pattern:
https://github.com/elixir-lang/dynamo/blob/v1.0/%{path}#L%{line}
** (exit) 1
lib/ex_doc/cli.ex:51: ExDoc.CLI.parse_args/1
lib/ex_doc/cli.ex:7: ExDoc.CLI.run/2
(elixir) src/elixir_lexical.erl:17: :elixir_lexical.run/3
(elixir) lib/code.ex:316: Code.require_file/2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment