Mix tasks: derive moduledoc from doc files
authorrinpatch <rinpatch@sdf.org>
Thu, 3 Oct 2019 10:59:49 +0000 (13:59 +0300)
committerrinpatch <rinpatch@sdf.org>
Thu, 3 Oct 2019 11:00:23 +0000 (14:00 +0300)
lib/mix/tasks/pleroma/database.ex
lib/mix/tasks/pleroma/digest.ex
lib/mix/tasks/pleroma/emoji.ex
lib/mix/tasks/pleroma/instance.ex
lib/mix/tasks/pleroma/relay.ex
lib/mix/tasks/pleroma/uploads.ex
lib/mix/tasks/pleroma/user.ex

index 81e687f648cd92f0bfd0022efb30ef3c0caa3640..cfd9eeada46ced0fd7a3449e59c45fe89f8aac82 100644 (file)
@@ -13,6 +13,7 @@ defmodule Mix.Tasks.Pleroma.Database do
   use Mix.Task
 
   @shortdoc "A collection of database related tasks"
+  @moduledoc File.read!("docs/administration/CLI_tasks/database.md")
 
   def run(["remove_embedded_objects" | args]) do
     {options, [], []} =
index 100a81060c88f8c426cecff2af90ed6ba4bd2843..7d09e70c5174755d8279efe4b9d1c480157416b6 100644 (file)
@@ -2,6 +2,7 @@ defmodule Mix.Tasks.Pleroma.Digest do
   use Mix.Task
 
   @shortdoc "Manages digest emails"
+  @moduledoc File.read!("docs/administration/CLI_tasks/digest.md")
 
   def run(["test", nickname | opts]) do
     Mix.Pleroma.start_pleroma()
index 32b92e6af737a18bb37cc8aa4c28a6db63d9fd3c..6ef0a635d083ad2788b0cc3afdb69f2bc6f6c9af 100644 (file)
@@ -6,6 +6,7 @@ defmodule Mix.Tasks.Pleroma.Emoji do
   use Mix.Task
 
   @shortdoc "Manages emoji packs"
+  @moduledoc File.read!("docs/administration/CLI_tasks/emoji.md")
 
   def run(["ls-packs" | args]) do
     Application.ensure_all_started(:hackney)
index 25f94ecebd433a7d625f41a53380add0463821fc..9af6cda3031523e663aafb3cfb55a44a94a40afe 100644 (file)
@@ -7,6 +7,7 @@ defmodule Mix.Tasks.Pleroma.Instance do
   import Mix.Pleroma
 
   @shortdoc "Manages Pleroma instance"
+  @moduledoc File.read!("docs/administration/CLI_tasks/instance.md")
 
   def run(["gen" | rest]) do
     {options, [], []} =
index 519f2d1b5500fc7f6b36f0a36eeb8ab74224360b..d7a7b599fee4f3a97a52edceb043f80b282fe5e6 100644 (file)
@@ -9,6 +9,7 @@ defmodule Mix.Tasks.Pleroma.Relay do
   alias Pleroma.Web.ActivityPub.Relay
 
   @shortdoc "Manages remote relays"
+  @moduledoc File.read!("docs/administration/CLI_tasks/relay.md")
 
   def run(["follow", target]) do
     start_pleroma()
index bc2248a76080981a818a992f9d0f6a193f11e5e8..3e6fc7ee05d47c07c4b2abe331b79e2b49e26737 100644 (file)
@@ -12,6 +12,7 @@ defmodule Mix.Tasks.Pleroma.Uploads do
   @log_every 50
 
   @shortdoc "Migrates uploads from local to remote storage"
+  @moduledoc File.read!("docs/administration/CLI_tasks/uploads.md")
 
   def run(["migrate_local", target_uploader | args]) do
     delete? = Enum.member?(args, "--delete")
index 3cf3ad2c666e5a73457687cb4271b68303a8b6ff..134b5bcccb4a66058071b44ed2f6e2f36ba1831f 100644 (file)
@@ -10,6 +10,7 @@ defmodule Mix.Tasks.Pleroma.User do
   alias Pleroma.Web.OAuth
 
   @shortdoc "Manages Pleroma users"
+  @moduledoc File.read!("docs/administration/CLI_tasks/user.md")
 
   def run(["new", nickname, email | rest]) do
     {options, [], []} =