docs: update spark & ex_doc for improved docs

ash-project · Sep 27, 2023 · ad475a2 · ad475a2
1 parent 067cd25
commit ad475a2
Show file tree

Hide file tree

Showing 3 changed files with 120 additions and 10 deletions.
diff --git a/documentation/dsls/DSL:-AshCsv.DataLayer.cheatmd b/documentation/dsls/DSL:-AshCsv.DataLayer.cheatmd
@@ -1,3 +1,6 @@
+<!--
+This file was generated by Spark. Do not edit it by hand.
+-->
 # DSL: AshCsv.DataLayer
 
 The data layer implementation for AshCsv
@@ -24,13 +27,120 @@ end
 
 
 ### Options
-| Name | Type | Default | Docs |
-| ---  | ---  | ---     | ---  |
-| `file`* | `String.t` |  | The file to read the data from |
-| `create?` | `boolean` | `false` | Whether or not the file should be created if it does not exist (this will only happen on writes) |
-| `header?` | `boolean` | `false` | If the csv file has a header that should be skipped |
-| `separator` | ``any`` | `44` | The separator to use, defaults to a comma. Pass in a character (not a string). |
-| `columns` | ``any`` |  | The order that the attributes appear in the columns of the CSV |
+
+<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="csv-file" href="#csv-file">
+      <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
+        file
+      </span>
+    </a>
+      <sup style="color: red">*</sup>
+
+  </td>
+  <td style="text-align: left">
+    <code class="inline">String.t</code>
+  </td>
+  <td style="text-align: left">
+
+  </td>
+  <td style="text-align: left" colspan=2>
+    The file to read the data from
+  </td>
+</tr>
+
+<tr>
+  <td style="text-align: left">
+    <a id="csv-create?" href="#csv-create?">
+      <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
+        create?
+      </span>
+    </a>
+
+  </td>
+  <td style="text-align: left">
+    <code class="inline">boolean</code>
+  </td>
+  <td style="text-align: left">
+    <code class="inline">false</code>
+  </td>
+  <td style="text-align: left" colspan=2>
+    Whether or not the file should be created if it does not exist (this will only happen on writes)
+  </td>
+</tr>
+
+<tr>
+  <td style="text-align: left">
+    <a id="csv-header?" href="#csv-header?">
+      <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
+        header?
+      </span>
+    </a>
+
+  </td>
+  <td style="text-align: left">
+    <code class="inline">boolean</code>
+  </td>
+  <td style="text-align: left">
+    <code class="inline">false</code>
+  </td>
+  <td style="text-align: left" colspan=2>
+    If the csv file has a header that should be skipped
+  </td>
+</tr>
+
+<tr>
+  <td style="text-align: left">
+    <a id="csv-separator" href="#csv-separator">
+      <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
+        separator
+      </span>
+    </a>
+
+  </td>
+  <td style="text-align: left">
+    <code class="inline">`any`</code>
+  </td>
+  <td style="text-align: left">
+    <code class="inline">44</code>
+  </td>
+  <td style="text-align: left" colspan=2>
+    The separator to use, defaults to a comma. Pass in a character (not a string).
+  </td>
+</tr>
+
+<tr>
+  <td style="text-align: left">
+    <a id="csv-columns" href="#csv-columns">
+      <span style="font-family: Inconsolata, Menlo, Courier, monospace;">
+        columns
+      </span>
+    </a>
+
+  </td>
+  <td style="text-align: left">
+    <code class="inline">`any`</code>
+  </td>
+  <td style="text-align: left">
+
+  </td>
+  <td style="text-align: left" colspan=2>
+    The order that the attributes appear in the columns of the CSV
+  </td>
+</tr>
+
+  </tbody>
+</table>
 
 
 

diff --git a/mix.exs b/mix.exs
@@ -123,7 +123,7 @@ defmodule AshCsv.MixProject do
     [
       {:ash, ash_version("~> 2.6")},
       {:csv, "~> 2.4"},
-      {:ex_doc, "~> 0.22", only: [:dev, :test], runtime: false},
+      {:ex_doc, github: "elixir-lang/ex_doc", only: [:dev, :test], runtime: false},
       {:ex_check, "~> 0.12.0", 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
@@ -13,7 +13,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.12.0", "c0e2919ecc06afeaf62c52d64f3d91bd4bc7dd8deaac5f84becb6278888c967a", [:mix], [], "hexpm", "cfafa8ef97c2596d45a1f19b5794cb5c7f700f25d164d3c9f8d7ec17ee67cf42"},
-  "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.13.1", "b9f1697f7c9e0cfe15d1a1d737fb169c398803ffcbc57e672aa007e9fd42864c", [:mix], [{:hackney, "~> 1.16", [hex: :hackney, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "b4bb550e045def1b4d531a37fb766cbbe1307f7628bf8f0414168b3f52021cce"},
   "file_system": {:hex, :file_system, "0.2.10", "fb082005a9cd1711c05b5248710f8826b02d7d1784e7c3451f9c1231d4fc162d", [:mix], [], "hexpm", "41195edbfb562a593726eda3b3e8b103a309b733ad25f3d642ba49696bf715dc"},
   "git_cli": {:hex, :git_cli, "0.3.0", "a5422f9b95c99483385b976f5d43f7e8233283a47cda13533d7c16131cb14df5", [:mix], [], "hexpm", "78cb952f4c86a41f4d3511f1d3ecb28edb268e3a7df278de2faa1bd4672eaf9b"},
@@ -33,7 +33,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.10.4", "44ba642da120d84fedb9e85473375084034330c8f15a992351dd164a82963103", [:mix], [], "hexpm", "fea62a94a4112de45ee9c9d076fd636fbbc10b7c7c2ea99a928e7c289b8498d1"},
   "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"},
   "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.7", "354c321cf377240c7b8716899e182ce4890c5938111a1296add3ec74cf1715df", [:make, :mix, :rebar3], [], "hexpm", "fe4c190e8f37401d30167c8c405eda19469f34577987c76dde613e838bbc67f8"},
   "stream_data": {:hex, :stream_data, "0.6.0", "e87a9a79d7ec23d10ff83eb025141ef4915eeb09d4491f79e52f2562b73e5f47", [:mix], [], "hexpm", "b92b5031b650ca480ced047578f1d57ea6dd563f5b57464ad274718c9c29501c"},
   "telemetry": {:hex, :telemetry, "1.2.1", "68fdfe8d8f05a8428483a97d7aab2f268aaff24b49e0f599faa091f1d4e7f61c", [:rebar3], [], "hexpm", "dad9ce9d8effc621708f99eac538ef1cbe05d6a874dd741de2e689c47feafed5"},