From: Alex S <alex.strizhakov@gmail.com>
Date: Fri, 30 Aug 2019 10:22:21 +0000 (+0300)
Subject: mix docs generates config.md
X-Git-Url: https://git.squeep.com/?a=commitdiff_plain;h=511d93fa5486a58b63576ce1b8af551bbafe703f;p=akkoma

mix docs generates config.md
---

diff --git a/lib/mix/tasks/pleroma/docs.ex b/lib/mix/tasks/pleroma/docs.ex
new file mode 100644
index 000000000..5ae3b8716
--- /dev/null
+++ b/lib/mix/tasks/pleroma/docs.ex
@@ -0,0 +1,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
diff --git a/mix.exs b/mix.exs
index 3170d6f2d..c52ab08b0 100644
--- a/mix.exs
+++ b/mix.exs
@@ -172,7 +172,8 @@ defmodule Pleroma.Mixfile do
       "ecto.rollback": ["pleroma.ecto.rollback"],
       "ecto.setup": ["ecto.create", "ecto.migrate", "run priv/repo/seeds.exs"],
       "ecto.reset": ["ecto.drop", "ecto.setup"],
-      test: ["ecto.create --quiet", "ecto.migrate", "test"]
+      test: ["ecto.create --quiet", "ecto.migrate", "test"],
+      docs: ["pleroma.docs", "docs"]
     ]
   end