Commit 511d93fa authored by Alexander Strizhakov's avatar Alexander Strizhakov

mix docs generates config.md

parent 67e43009
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
......@@ -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
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment