https://github.com/erlang/rebar3_otpdoc_plugin

https://github.com/erlang/rebar3_otpdoc_plugin

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/erlang/rebar3_otpdoc_plugin
• Owner: erlang
• License: other
• Created: 2016-10-06T09:04:41.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-03-10T15:42:33.000Z (over 9 years ago)
• Last Synced: 2025-02-09T14:18:36.580Z (over 1 year ago)
• Language: Erlang
• Size: 37.1 KB
• Stars: 0
• Watchers: 24
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
rebar3_otpdoc_plugin

=====

A rebar3 plugin for building OTP documentation

Use

---

Add the plugin to your rebar config:

    {plugins, [

        {rebar3_otpdoc_plugin, {git, "https://github.com/erlang/rebar3_otpdoc_plugin.git", {branch, "master"}}}

    ]}.

Generate documentation by calling `doc` under namespace `otp`.

    $ rebar3 otp doc

    ===> Generating specification-files

    ===> Installing html-files

    ===> Installing man-files

Options

-------

Useful rebar.config options.

    {otpdoc_opts, [{doc_src, string()},           %% default: $APP/doc/src

                   {company, string()},           %% default: "Ericsson AB"

                   {edoc_modules, [atom()]},      %% default: []

                   {edoc_chapters, [string()]},   %% default: [], ex.: "doc/overview.edoc"

                   {images, [string()]}           %% default: $APP/doc/src/**.{gif,jpeg,jpg,png}

                  ]}.