aboutsummaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
Diffstat (limited to 'lib')
-rw-r--r--lib/mix/tasks/pleroma/docs.ex40
1 files changed, 40 insertions, 0 deletions
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