docs: update spark & ex_doc to get better docs

ash-project · Sep 27, 2023 · 5e79b82 · 5e79b82
1 parent 1c973fc
commit 5e79b82
Show file tree

Hide file tree

Showing 5 changed files with 257 additions and 19 deletions.
diff --git a/documentation/dsls/DSL:-AshDoubleEntry.Account.cheatmd b/documentation/dsls/DSL:-AshDoubleEntry.Account.cheatmd
@@ -1,3 +1,6 @@
+<!--
+This file was generated by Spark. Do not edit it by hand.
+-->
 # DSL: AshDoubleEntry.Account
 
 An extension for creating a double entry ledger account. See the getting started guide for more.
@@ -12,12 +15,102 @@ An extension for creating a double entry ledger account. See the getting started
 
 
 ### Options
-| Name | Type | Default | Docs |
-| ---  | ---  | ---     | ---  |
-| `transfer_resource`* | `module` |  | The resource used for transfers |
-| `balance_resource`* | `module` |  | The resource used for balances |
-| `open_action_accept` | `list(atom)` | `[]` | A list of extra attributes to be accepted by the open action. The `identifier` and `currency` attributes are always accepted. |
-| `pre_check_identities_with` | `module` |  | An api to use to precheck generated identities. Required by certain data layers. |
+
+<table>
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th>Type</th>
+      <th>Default</th>
+      <th colspan=2>Docs</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+  <td style="text-align: left">
+    <a id="account-transfer_resource" href="#account-transfer_resource">
+      <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
+        transfer_resource
+      </span>
+    </a>
+      <sup style="color: red">*</sup>
+
+  </td>
+  <td style="text-align: left">
+    <code class="inline">module</code>
+  </td>
+  <td style="text-align: left">
+
+  </td>
+  <td style="text-align: left" colspan=2>
+    The resource used for transfers
+  </td>
+</tr>
+
+<tr>
+  <td style="text-align: left">
+    <a id="account-balance_resource" href="#account-balance_resource">
+      <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
+        balance_resource
+      </span>
+    </a>
+      <sup style="color: red">*</sup>
+
+  </td>
+  <td style="text-align: left">
+    <code class="inline">module</code>
+  </td>
+  <td style="text-align: left">
+
+  </td>
+  <td style="text-align: left" colspan=2>
+    The resource used for balances
+  </td>
+</tr>
+
+<tr>
+  <td style="text-align: left">
+    <a id="account-open_action_accept" href="#account-open_action_accept">
+      <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
+        open_action_accept
+      </span>
+    </a>
+
+  </td>
+  <td style="text-align: left">
+    <code class="inline">list(atom)</code>
+  </td>
+  <td style="text-align: left">
+    <code class="inline">[]</code>
+  </td>
+  <td style="text-align: left" colspan=2>
+    A list of extra attributes to be accepted by the open action. The `identifier` and `currency` attributes are always accepted.
+
+  </td>
+</tr>
+
+<tr>
+  <td style="text-align: left">
+    <a id="account-pre_check_identities_with" href="#account-pre_check_identities_with">
+      <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
+        pre_check_identities_with
+      </span>
+    </a>
+
+  </td>
+  <td style="text-align: left">
+    <code class="inline">module</code>
+  </td>
+  <td style="text-align: left">
+
+  </td>
+  <td style="text-align: left" colspan=2>
+    An api to use to precheck generated identities. Required by certain data layers.
+  </td>
+</tr>
+
+  </tbody>
+</table>
 
 
 

diff --git a/documentation/dsls/DSL:-AshDoubleEntry.Balance.cheatmd b/documentation/dsls/DSL:-AshDoubleEntry.Balance.cheatmd
@@ -1,3 +1,6 @@
+<!--
+This file was generated by Spark. Do not edit it by hand.
+-->
 # DSL: AshDoubleEntry.Balance
 
 An extension for creating a double entry ledger balance. See the getting started guide for more.
@@ -12,11 +15,81 @@ An extension for creating a double entry ledger balance. See the getting started
 
 
 ### Options
-| Name | Type | Default | Docs |
-| ---  | ---  | ---     | ---  |
-| `transfer_resource`* | `module` |  | The resource used for transfers |
-| `account_resource`* | `module` |  | The resource used for accounts |
-| `pre_check_identities_with` | `module` |  | An api to use to precheck generated identities. Required by certain data layers. |
+
+<table>
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th>Type</th>
+      <th>Default</th>
+      <th colspan=2>Docs</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+  <td style="text-align: left">
+    <a id="balance-transfer_resource" href="#balance-transfer_resource">
+      <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
+        transfer_resource
+      </span>
+    </a>
+      <sup style="color: red">*</sup>
+
+  </td>
+  <td style="text-align: left">
+    <code class="inline">module</code>
+  </td>
+  <td style="text-align: left">
+
+  </td>
+  <td style="text-align: left" colspan=2>
+    The resource used for transfers
+  </td>
+</tr>
+
+<tr>
+  <td style="text-align: left">
+    <a id="balance-account_resource" href="#balance-account_resource">
+      <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
+        account_resource
+      </span>
+    </a>
+      <sup style="color: red">*</sup>
+
+  </td>
+  <td style="text-align: left">
+    <code class="inline">module</code>
+  </td>
+  <td style="text-align: left">
+
+  </td>
+  <td style="text-align: left" colspan=2>
+    The resource used for accounts
+  </td>
+</tr>
+
+<tr>
+  <td style="text-align: left">
+    <a id="balance-pre_check_identities_with" href="#balance-pre_check_identities_with">
+      <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
+        pre_check_identities_with
+      </span>
+    </a>
+
+  </td>
+  <td style="text-align: left">
+    <code class="inline">module</code>
+  </td>
+  <td style="text-align: left">
+
+  </td>
+  <td style="text-align: left" colspan=2>
+    An api to use to precheck generated identities. Required by certain data layers.
+  </td>
+</tr>
+
+  </tbody>
+</table>
 
 
 

diff --git a/documentation/dsls/DSL:-AshDoubleEntry.Transfer.cheatmd b/documentation/dsls/DSL:-AshDoubleEntry.Transfer.cheatmd
@@ -1,3 +1,6 @@
+<!--
+This file was generated by Spark. Do not edit it by hand.
+-->
 # DSL: AshDoubleEntry.Transfer
 
 An extension for creating a double entry ledger transfer. See the getting started guide for more.
@@ -12,11 +15,80 @@ An extension for creating a double entry ledger transfer. See the getting starte
 
 
 ### Options
-| Name | Type | Default | Docs |
-| ---  | ---  | ---     | ---  |
-| `account_resource`* | `module` |  | The resource to use for account balances |
-| `pre_check_identities_with` | `module` |  | An api to use to precheck generated identities. Required by certain data layers. |
-| `balance_resource` | `module` |  | The resource being used for balances |
+
+<table>
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th>Type</th>
+      <th>Default</th>
+      <th colspan=2>Docs</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+  <td style="text-align: left">
+    <a id="transfer-account_resource" href="#transfer-account_resource">
+      <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
+        account_resource
+      </span>
+    </a>
+      <sup style="color: red">*</sup>
+
+  </td>
+  <td style="text-align: left">
+    <code class="inline">module</code>
+  </td>
+  <td style="text-align: left">
+
+  </td>
+  <td style="text-align: left" colspan=2>
+    The resource to use for account balances
+  </td>
+</tr>
+
+<tr>
+  <td style="text-align: left">
+    <a id="transfer-pre_check_identities_with" href="#transfer-pre_check_identities_with">
+      <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
+        pre_check_identities_with
+      </span>
+    </a>
+
+  </td>
+  <td style="text-align: left">
+    <code class="inline">module</code>
+  </td>
+  <td style="text-align: left">
+
+  </td>
+  <td style="text-align: left" colspan=2>
+    An api to use to precheck generated identities. Required by certain data layers.
+  </td>
+</tr>
+
+<tr>
+  <td style="text-align: left">
+    <a id="transfer-balance_resource" href="#transfer-balance_resource">
+      <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
+        balance_resource
+      </span>
+    </a>
+
+  </td>
+  <td style="text-align: left">
+    <code class="inline">module</code>
+  </td>
+  <td style="text-align: left">
+
+  </td>
+  <td style="text-align: left" colspan=2>
+    The resource being used for balances
+  </td>
+</tr>
+
+  </tbody>
+</table>
 
 
 

diff --git a/mix.exs b/mix.exs
@@ -159,7 +159,7 @@ defmodule AshDoubleEntry.MixProject do
     [
       {:ash, ash_version("~> 2.14")},
       {:git_ops, "~> 2.5", only: [:dev, :test]},
-      {:ex_doc, "~> 0.22", only: [:dev, :test], runtime: false},
+      {:ex_doc, github: "elixir-lang/ex_doc", only: [:dev, :test], runtime: false},
       {:ex_check, "~> 0.14", only: [:dev, :test]},
       {:credo, ">= 0.0.0", only: [:dev, :test], runtime: false},
       {:dialyxir, ">= 0.0.0", only: [:dev, :test], runtime: false},

diff --git a/mix.lock b/mix.lock
@@ -11,7 +11,7 @@
   "erlex": {:hex, :erlex, "0.2.6", "c7987d15e899c7a2f34f5420d2a2ea0d659682c06ac607572df55a43753aa12e", [:mix], [], "hexpm", "2ed2e25711feb44d52b17d2780eabf998452f6efda104877a3881c2f8c0c0c75"},
   "ets": {:hex, :ets, "0.9.0", "79c6a6c205436780486f72d84230c6cba2f8a9920456750ddd1e47389107d5fd", [:mix], [], "hexpm", "2861fdfb04bcaeff370f1a5904eec864f0a56dcfebe5921ea9aadf2a481c822b"},
   "ex_check": {:hex, :ex_check, "0.15.0", "074b94c02de11c37bba1ca82ae5cc4926e6ccee862e57a485b6ba60fca2d8dc1", [:mix], [], "hexpm", "33848031a0c7e4209c3b4369ce154019788b5219956220c35ca5474299fb6a0e"},
-  "ex_doc": {:hex, :ex_doc, "0.30.6", "5f8b54854b240a2b55c9734c4b1d0dd7bdd41f71a095d42a70445c03cf05a281", [:mix], [{:earmark_parser, "~> 1.4.31", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1", [hex: :makeup_erlang, repo: "hexpm", optional: false]}], "hexpm", "bd48f2ddacf4e482c727f9293d9498e0881597eae6ddc3d9562bd7923375109f"},
+  "ex_doc": {:git, "https://github.com/elixir-lang/ex_doc.git", "16a8f536d1a0868293a30d63bcff6510bf023de3", []},
   "excoveralls": {:hex, :excoveralls, "0.17.0", "279f124dba347903bb654bc40745c493ae265d45040001b4899ea1edf88078c7", [:mix], [{:castore, "~> 1.0", [hex: :castore, repo: "hexpm", optional: true]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "08b638d114387a888f9cb8d65f2a0021ec04c3e447b793efa7c1e734aba93004"},
   "file_system": {:hex, :file_system, "0.2.10", "fb082005a9cd1711c05b5248710f8826b02d7d1784e7c3451f9c1231d4fc162d", [:mix], [], "hexpm", "41195edbfb562a593726eda3b3e8b103a309b733ad25f3d642ba49696bf715dc"},
   "git_cli": {:hex, :git_cli, "0.3.0", "a5422f9b95c99483385b976f5d43f7e8233283a47cda13533d7c16131cb14df5", [:mix], [], "hexpm", "78cb952f4c86a41f4d3511f1d3ecb28edb268e3a7df278de2faa1bd4672eaf9b"},
@@ -25,7 +25,7 @@
   "picosat_elixir": {:hex, :picosat_elixir, "0.2.3", "bf326d0f179fbb3b706bb2c15fbc367dacfa2517157d090fdfc32edae004c597", [:make, :mix], [{:elixir_make, "~> 0.6", [hex: :elixir_make, repo: "hexpm", optional: false]}], "hexpm", "f76c9db2dec9d2561ffaa9be35f65403d53e984e8cd99c832383b7ab78c16c66"},
   "sobelow": {:hex, :sobelow, "0.13.0", "218afe9075904793f5c64b8837cc356e493d88fddde126a463839351870b8d1e", [:mix], [{:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "cd6e9026b85fc35d7529da14f95e85a078d9dd1907a9097b3ba6ac7ebbe34a0d"},
   "sourceror": {:hex, :sourceror, "0.14.0", "b6b8552d0240400d66b6f107c1bab7ac1726e998efc797f178b7b517e928e314", [:mix], [], "hexpm", "809c71270ad48092d40bbe251a133e49ae229433ce103f762a2373b7a10a8d8b"},
-  "spark": {:hex, :spark, "1.1.39", "f143b84a5b796bf2d83ec8fb4793ee9e66e67510c40d785f9a67050bb88e7677", [:mix], [{:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}, {:nimble_options, "~> 0.5 or ~> 1.0", [hex: :nimble_options, repo: "hexpm", optional: false]}, {:sourceror, "~> 0.1", [hex: :sourceror, repo: "hexpm", optional: false]}], "hexpm", "d71bc26014c7e7abcdcf553f4cf7c5a5ff96f8365b1e20be3768ce503aafb203"},
+  "spark": {:hex, :spark, "1.1.40", "b61438fece40eb0ffed7c4c9e5f1c2c817209902ed853b0008b7681b1994c29c", [:mix], [{:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}, {:nimble_options, "~> 0.5 or ~> 1.0", [hex: :nimble_options, repo: "hexpm", optional: false]}, {:sourceror, "~> 0.1", [hex: :sourceror, repo: "hexpm", optional: false]}], "hexpm", "40d0f803f1090249ef6a76cb2bf40466c57f4995326dc97996e0b8b4f365ad17"},
   "stream_data": {:hex, :stream_data, "0.6.0", "e87a9a79d7ec23d10ff83eb025141ef4915eeb09d4491f79e52f2562b73e5f47", [:mix], [], "hexpm", "b92b5031b650ca480ced047578f1d57ea6dd563f5b57464ad274718c9c29501c"},
   "telemetry": {:hex, :telemetry, "1.2.1", "68fdfe8d8f05a8428483a97d7aab2f268aaff24b49e0f599faa091f1d4e7f61c", [:rebar3], [], "hexpm", "dad9ce9d8effc621708f99eac538ef1cbe05d6a874dd741de2e689c47feafed5"},
   "typable": {:hex, :typable, "0.3.0", "0431e121d124cd26f312123e313d2689b9a5322b15add65d424c07779eaa3ca1", [:mix], [], "hexpm", "880a0797752da1a4c508ac48f94711e04c86156f498065a83d160eef945858f8"},