Packages

blue_bird

0.1.3
0.4.2 0.4.1 0.4.0 0.3.8 0.3.7 0.3.6 0.3.5 0.3.4 0.3.3 0.3.2 0.3.1 0.3.0 0.2.0 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0

BlueBird generates API documentation from annotations in controllers actions and tests cases.

HexDocs

Current section

Files

Jump to
Readme
18 Versions
3 Dependencies
Dependants
Files
Activity
blue_bird lib mix tasks bird.gen.docs.ex
Raw

lib/mix/tasks/bird.gen.docs.ex 

defmodule Mix.Tasks.Bird.Gen.Docs do

  use Mix.Task



  @shortdoc "Generates HTML API Docs from api.apib using Aglio"

  @moduledoc @shortdoc



  @doc false

  def run(_args) do

    if System.find_executable("aglio") == nil do

      raise "Install Aglio to convert Blueprint API to HTML: \"npm install aglio -g\""

    end



    docs_path = Application.get_env(:blue_bird, :docs_path, "docs")

    docs_theme = Application.get_env(:blue_bird, :docs_theme, "triple")

    project_path = Mix.Project.load_paths |> Enum.at(0) |> String.split("_build") |> Enum.at(0)

    path = Path.join(project_path, docs_path)



    System.cmd("aglio", ["--theme-template", docs_theme, "-i", Path.join(path, "api.apib"), "-o", Path.join(path, "index.html")])

  end



end