akkoma/lib/mix/tasks/pleroma/docs.ex

47 lines
1.1 KiB
Elixir
Raw Normal View History

2020-10-12 17:00:50 +00:00
# Pleroma: A lightweight social networking server
# Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
2020-10-12 17:00:50 +00:00
# SPDX-License-Identifier: AGPL-3.0-only
2019-08-30 10:22:21 +00:00
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`.
2019-08-30 16:14:01 +00:00
## Generate Markdown docs
2019-08-30 10:22:21 +00:00
`mix pleroma.docs`
2019-08-30 16:14:01 +00:00
## Generate JSON docs
2019-08-30 10:22:21 +00:00
2019-08-30 16:59:13 +00:00
`mix pleroma.docs json`
2019-08-30 10:22:21 +00:00
"""
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 <- Pleroma.Config.Loader.read("config/description.exs"),
2019-09-03 17:11:32 +00:00
{:ok, file_path} <-
Pleroma.Docs.Generator.process(
implementation,
descriptions[:pleroma][:config_description]
) do
type = if implementation == Pleroma.Docs.Markdown, do: "Markdown", else: "JSON"
2019-08-30 10:22:21 +00:00
2019-09-03 17:11:32 +00:00
Mix.shell().info([:green, "#{type} docs successfully generated to #{file_path}."])
end
2019-08-30 10:22:21 +00:00
end
end