lib/mix/tasks/pleroma/docs.ex


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

defmodule Mix.Tasks.Pleroma.Docs do
  use Mix.Task
  import Mix.Pleroma

  @shortdoc "Generates docs from descriptions.exs"
  @moduledoc """
  Generates docs from `descriptions.exs`.

  Supports two formats: `markdown` and `json`.

  ## Generate markdown docs

  `mix pleroma.docs`

  ## Generate json docs

  `mix pleroma.docs json`s
  """

  def run(["json"]) do
    do_run(Pleroma.Docs.JSON)
  end

  def run(_) do
    do_run(Pleroma.Docs.Markdown)
  end

  defp do_run(implementation) do
    start_pleroma()
    descriptions = Config.Reader.read!("config/description.exs")

    {:ok, file_path} =
      Pleroma.Docs.Formatter.process(
        implementation,
        descriptions[:pleroma][:config_description]
      )

    Mix.shell().info([:green, "Markdown docs successfully generated to #{file_path}."])
  end
end