feat:doc: stub doc headers for database tables

lib/notifications/db/block_waiver.ex

@@ -1,5 +1,7 @@
 defmodule Notifications.Db.BlockWaiver do
-  @moduledoc false
+  @moduledoc """
+  Ecto Model for `block_waivers` Database table
+  """
 
   use Skate.Schema
   import Ecto.Changeset

lib/notifications/db/bridge_movement.ex

@@ -1,5 +1,7 @@
 defmodule Notifications.Db.BridgeMovement do
-  @moduledoc false
+  @moduledoc """
+  Ecto Model for `bridge_movements` Database table
+  """
 
   use Skate.Schema
   import Ecto.Changeset

lib/notifications/db/notification.ex

@@ -1,5 +1,7 @@
 defmodule Notifications.Db.Notification do
-  @moduledoc false
+  @moduledoc """
+  Ecto Model for `notifications` Database table
+  """
 
   use Skate.Schema
   import Ecto.Changeset

lib/notifications/db/notification_user.ex

@@ -1,5 +1,7 @@
 defmodule Notifications.Db.NotificationUser do
-  @moduledoc false
+  @moduledoc """
+  Ecto Model for `notification_users` Database table
+  """
 
   use Skate.Schema
 

lib/skate/detours/db/detour.ex

@@ -1,5 +1,7 @@
 defmodule Skate.Detours.Db.Detour do
-  @moduledoc false
+  @moduledoc """
+  Ecto Model for `detours` Database table
+  """
 
   use Skate.Schema
   import Ecto.Changeset

lib/skate/schema.ex

@@ -5,6 +5,8 @@ defmodule Skate.Schema do
 
   defmacro __using__(_opts) do
     quote do
+      @moduledoc section: :ecto
+
       use TypedEctoSchema
     end
   end

lib/skate/settings/db/route_tab.ex

@@ -1,5 +1,7 @@
 defmodule Skate.Settings.Db.RouteTab do
-  @moduledoc false
+  @moduledoc """
+  Ecto Model for `route_tabs` Database table
+  """
 
   use Skate.Schema
   import Ecto.Changeset

lib/skate/settings/db/test_group.ex

@@ -1,5 +1,7 @@
 defmodule Skate.Settings.Db.TestGroup do
-  @moduledoc false
+  @moduledoc """
+  Ecto Model for `test_groups` Database table
+  """
 
   use Skate.Schema
   import Ecto.Changeset

lib/skate/settings/db/test_group_user.ex

@@ -1,5 +1,7 @@
 defmodule Skate.Settings.Db.TestGroupUser do
-  @moduledoc false
+  @moduledoc """
+  Ecto Model for `test_groups_users` Database table
+  """
 
   use Skate.Schema
   import Ecto.Changeset

lib/skate/settings/db/user.ex

@@ -1,5 +1,7 @@
 defmodule Skate.Settings.Db.User do
-  @moduledoc false
+  @moduledoc """
+  Ecto Model for `users` Database table
+  """
 
   use Skate.Schema
   import Ecto.Changeset

lib/skate/settings/db/user_settings.ex

@@ -1,5 +1,7 @@
 defmodule Skate.Settings.Db.UserSettings do
-  @moduledoc false
+  @moduledoc """
+  Ecto Model for `user_settings` Database table
+  """
 
   use Skate.Schema
   import Ecto.Changeset

mix.exs

@@ -15,10 +15,18 @@ defmodule Skate.MixProject do
       consolidate_protocols: Mix.env() != :test,
       dialyzer: [
         plt_add_apps: [:mix]
-      ]
+      ],
+      docs: docs_config()
     ]
   end
 
+  def docs_config,
+    do: [
+      groups_for_modules: [
+        "Ecto Schemas": &(&1[:section] == :ecto)
+      ]
+    ]
+
   # Configuration for the OTP application.
   #
   # Type `mix help compile.app` for more information.