Covfefe v0.0.1 mix docs View Source

Uses ExDoc to generate a static web page from the project documentation.

Command line options

  • --canonical, -n - Indicate the preferred URL with rel=”canonical” link element, defaults to no canonical path

  • --formatter, -f - Which formatters to use, “html” or “epub”, default: “html” (may be given more than once)

  • --output, -o - Output directory for the generated docs, default: "doc"

The command line options have higher precedence than the options specified in your mix.exs file below.

Configuration

ExDoc will automatically pull in information from your project, like the application and version. However, you may want to set :name, :source_url and :homepage_url to have a nicer output from ExDoc, for example:

def project do
  [app: :my_app,
   version: "0.1.0-dev",
   deps: deps(),

   # Docs
   name: "My App",
   source_url: "https://github.com/USER/PROJECT",
   homepage_url: "http://YOUR_PROJECT_HOMEPAGE",
   docs: [main: "MyApp", # The main page in the docs
          logo: "path/to/logo.png",
          extras: ["README.md"]]]
end

ExDoc also allows configuration specific to the documentation to be set. The following options should be put under the :docs key in your project’s main configuration. The :docs options should be a keyword list or a function returning a keyword list that will be lazily executed.

  • :assets - Path to a directory that will be copied as is to the “assets” directory in the output path. Its entries may be referenced in your docs under “assets/ASSET.EXTENSION”; defaults to no assets directory.

  • :canonical - String that defines the preferred URL with the rel=”canonical” element; defaults to no canonical path.

  • :deps - A keyword list application names and their documentation URL. ExDoc will by default include all dependencies and assume they are hosted on HexDocs. This can be overridden by your own values. Example: [plug: "https://myserver/plug/"]

  • :extra_section - String that defines the section title of the additional Markdown pages; default: “PAGES”. Example: “GUIDES”

  • :extras - List of keywords, each key must indicate the path to additional Markdown pages, the value for each keyword (optional) gives you more control about the PATH and the title of the output files; default: []. Example: ["README.md", "CONTRIBUTING.md": [filename: "contributing", title: "Contributing", group: "Join us!"]]

  • :filter_prefix - Include only modules that match the given prefix in the generated documentation. Example: “MyApp.Core”

  • :formatters - Formatter to use; default: [“html”], options: “html”, “epub”.

  • :language - Identify the primary language of the documents, its value must be a valid BCP 47 language tag; default: “en”

  • :logo - Path to the image logo of the project (only PNG or JPEG accepted) The image size will be 64x64. When specified, the logo will be placed under the “assets” directory in the output path under the name “logo” and the appropriate extension.

  • :main - Main page of the documentation. It may be a module or a generated page, like “Plug” or “api-reference”; default: “api-reference”.

  • :source_beam - Path to the beam directory; default: mix’s compile path.

  • :source_ref - The branch/commit/tag used for source link inference; default: “master”.

  • :source_root - Path to the source code root directory; default: “.” (current directory).

  • :source_url_pattern - Public URL of the project. Derived from project’s :source_url and :source_ref. Example: “https://github.com/USER/APP/blob/master/%{path}#L%{line}”

  • :output - Output directory for the generated docs; default: “doc”. May be overridden by command line argument.

Umbrella project

ExDoc can be used in an umbrella project and generates a single documentation for all child apps.

Generating documentation per each child app can be achieved by running:

mix cmd mix docs

See mix help cmd for more information.