diff options
author | Ivan Tashkinov <ivantashkinov@gmail.com> | 2019-09-15 18:52:27 +0300 |
---|---|---|
committer | Ivan Tashkinov <ivantashkinov@gmail.com> | 2019-09-15 18:52:27 +0300 |
commit | efbc2edba17a7ee2d3e15bca5fa4f6cf8b4b5116 (patch) | |
tree | 086f3bb1ae6ca2fbb9909e69297a7dabea9061fb /lib/mix/tasks/pleroma/docs.ex | |
parent | e6f43a831bdd2a381ed4de493344886f312f9a38 (diff) | |
parent | 9c64a25713790fefa8b5c419aeadf55113c17073 (diff) | |
download | pleroma-efbc2edba17a7ee2d3e15bca5fa4f6cf8b4b5116.tar.gz |
[#1234] Merge remote-tracking branch 'remotes/upstream/develop' into 1234-mastodon-2-4-3-oauth-scopes
# Conflicts:
# lib/pleroma/web/activity_pub/activity_pub_controller.ex
# lib/pleroma/web/router.ex
Diffstat (limited to 'lib/mix/tasks/pleroma/docs.ex')
-rw-r--r-- | lib/mix/tasks/pleroma/docs.ex | 42 |
1 files changed, 42 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..0d2663648 --- /dev/null +++ b/lib/mix/tasks/pleroma/docs.ex @@ -0,0 +1,42 @@ +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` + """ + + 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() + + with {descriptions, _paths} <- Mix.Config.eval!("config/description.exs"), + {:ok, file_path} <- + Pleroma.Docs.Generator.process( + implementation, + descriptions[:pleroma][:config_description] + ) do + type = if implementation == Pleroma.Docs.Markdown, do: "Markdown", else: "JSON" + + Mix.shell().info([:green, "#{type} docs successfully generated to #{file_path}."]) + end + end +end |