Deployed 7ed2931 with MkDocs version: 1.6.1

DataShades · Jan 14, 2025 · 4258f0b · 4258f0b
1 parent de6dcd3
commit 4258f0b
Show file tree

Hide file tree

Showing 33 changed files with 204 additions and 387 deletions.
diff --git a/404.html b/404.html
@@ -12,15 +12,15 @@
 
 
       <link rel="icon" href="/ckanext-event-audit/img/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.46">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">
 
 
 
         <title>ckanext-event-audit</title>
 
 
 
-      <link rel="stylesheet" href="/ckanext-event-audit/assets/stylesheets/main.6f8fc17f.min.css">
+      <link rel="stylesheet" href="/ckanext-event-audit/assets/stylesheets/main.0253249f.min.css">
 
 
         <link rel="stylesheet" href="/ckanext-event-audit/assets/stylesheets/palette.06af60db.min.css">
@@ -190,7 +190,7 @@
         <a href="https://github.com/DataShades/ckanext-event-audit" title="Go to repository" class="md-source" data-md-component="source">
   <div class="md-source__icon md-icon">
 
-    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
   </div>
   <div class="md-source__repository">
     GitHub
@@ -235,7 +235,7 @@
       <a href="https://github.com/DataShades/ckanext-event-audit" title="Go to repository" class="md-source" data-md-component="source">
   <div class="md-source__icon md-icon">
 
-    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
   </div>
   <div class="md-source__repository">
     GitHub

diff --git a/assets/_mkdocstrings.css b/assets/_mkdocstrings.css
@@ -26,33 +26,20 @@
   float: right;
 }
 
-/* Parameter headings must be inline, not blocks. */
-.doc-heading-parameter {
-  display: inline;
-}
-
-/* Prefer space on the right, not the left of parameter permalinks. */
-.doc-heading-parameter .headerlink {
-  margin-left: 0 !important;
-  margin-right: 0.2rem;
-}
-
 /* Backward-compatibility: docstring section titles in bold. */
 .doc-section-title {
   font-weight: bold;
 }
 
 /* Symbols in Navigation and ToC. */
-:root, :host,
+:root,
 [data-md-color-scheme="default"] {
-  --doc-symbol-parameter-fg-color: #df50af;
   --doc-symbol-attribute-fg-color: #953800;
   --doc-symbol-function-fg-color: #8250df;
   --doc-symbol-method-fg-color: #8250df;
   --doc-symbol-class-fg-color: #0550ae;
   --doc-symbol-module-fg-color: #5cad0f;
 
-  --doc-symbol-parameter-bg-color: #df50af1a;
   --doc-symbol-attribute-bg-color: #9538001a;
   --doc-symbol-function-bg-color: #8250df1a;
   --doc-symbol-method-bg-color: #8250df1a;
@@ -61,14 +48,12 @@
 }
 
 [data-md-color-scheme="slate"] {
-  --doc-symbol-parameter-fg-color: #ffa8cc;
   --doc-symbol-attribute-fg-color: #ffa657;
   --doc-symbol-function-fg-color: #d2a8ff;
   --doc-symbol-method-fg-color: #d2a8ff;
   --doc-symbol-class-fg-color: #79c0ff;
   --doc-symbol-module-fg-color: #baff79;
 
-  --doc-symbol-parameter-bg-color: #ffa8cc1a;
   --doc-symbol-attribute-bg-color: #ffa6571a;
   --doc-symbol-function-bg-color: #d2a8ff1a;
   --doc-symbol-method-bg-color: #d2a8ff1a;
@@ -83,15 +68,6 @@ code.doc-symbol {
   font-weight: bold;
 }
 
-code.doc-symbol-parameter {
-  color: var(--doc-symbol-parameter-fg-color);
-  background-color: var(--doc-symbol-parameter-bg-color);
-}
-
-code.doc-symbol-parameter::after {
-  content: "param";
-}
-
 code.doc-symbol-attribute {
   color: var(--doc-symbol-attribute-fg-color);
   background-color: var(--doc-symbol-attribute-bg-color);

diff --git a/assets/stylesheets/main.0253249f.min.css b/assets/stylesheets/main.0253249f.min.css
diff --git a/assets/stylesheets/main.0253249f.min.css.map b/assets/stylesheets/main.0253249f.min.css.map
diff --git a/assets/stylesheets/main.6f8fc17f.min.css b/assets/stylesheets/main.6f8fc17f.min.css
diff --git a/assets/stylesheets/main.6f8fc17f.min.css.map b/assets/stylesheets/main.6f8fc17f.min.css.map
diff --git a/cli/index.html b/cli/index.html
@@ -18,15 +18,15 @@
 
 
       <link rel="icon" href="../img/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.46">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">
 
 
 
         <title>CLI - ckanext-event-audit</title>
 
 
 
-      <link rel="stylesheet" href="../assets/stylesheets/main.6f8fc17f.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.0253249f.min.css">
 
 
         <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
@@ -201,7 +201,7 @@
         <a href="https://github.com/DataShades/ckanext-event-audit" title="Go to repository" class="md-source" data-md-component="source">
   <div class="md-source__icon md-icon">
 
-    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
   </div>
   <div class="md-source__repository">
     GitHub
@@ -246,7 +246,7 @@
       <a href="https://github.com/DataShades/ckanext-event-audit" title="Go to repository" class="md-source" data-md-component="source">
   <div class="md-source__icon md-icon">
 
-    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
   </div>
   <div class="md-source__repository">
     GitHub
@@ -1051,11 +1051,6 @@ <h1 id="cli">CLI</h1>
 
 
 
-
-
-
-
-
   <div class="doc doc-children">
 
 
@@ -1089,9 +1084,7 @@ <h2 id="event_audit.cli.export_data" class="doc doc-heading">
       </thead>
       <tbody>
           <tr class="doc-section-item">
-            <td>
-                <code>exporter_name</code>
-            </td>
+            <td><code>exporter_name</code></td>
             <td class="doc-param-details">
               <div class="doc-md-description">
                 <p>The name of the exporter.</p>
@@ -1105,9 +1098,7 @@ <h2 id="event_audit.cli.export_data" class="doc doc-heading">
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td>
-                <code>start</code>
-            </td>
+            <td><code>start</code></td>
             <td class="doc-param-details">
               <div class="doc-md-description">
                 <p>The start date string in %Y-%m-%d format.</p>
@@ -1121,9 +1112,7 @@ <h2 id="event_audit.cli.export_data" class="doc doc-heading">
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td>
-                <code>end</code>
-            </td>
+            <td><code>end</code></td>
             <td class="doc-param-details">
               <div class="doc-md-description">
                 <p>The end date string in %Y-%m-%d format.</p>
@@ -1137,9 +1126,7 @@ <h2 id="event_audit.cli.export_data" class="doc doc-heading">
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td>
-                <code>config</code>
-            </td>
+            <td><code>config</code></td>
             <td class="doc-param-details">
               <div class="doc-md-description">
                 <p>The exporter config in JSON format. See the exporter's
@@ -1167,11 +1154,13 @@ <h2 id="event_audit.cli.export_data" class="doc doc-heading">
       <tbody>
           <tr class="doc-section-item">
             <td>
-                <code>str</code>
+                <span class="doc-returns-annotation">
+                    <code>None</code>
+                </span>
             </td>
             <td class="doc-returns-details">
               <div class="doc-md-description">
-                <p>The exported data</p>
+                <p>The exported data will be printed to the standard output.</p>
               </div>
             </td>
           </tr>
@@ -1259,7 +1248,7 @@ <h2 id="event_audit.cli.export_data" class="doc doc-heading">
     <span class="n">help</span><span class="o">=</span><span class="s2">&quot;ISO format end date&quot;</span><span class="p">,</span>
 <span class="p">)</span>
 <span class="nd">@click</span><span class="o">.</span><span class="n">option</span><span class="p">(</span><span class="s2">&quot;--config&quot;</span><span class="p">,</span> <span class="n">required</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="nb">str</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Custom config in JSON format&quot;</span><span class="p">)</span>
-<span class="k">def</span> <span class="nf">export_data</span><span class="p">(</span><span class="n">exporter_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">start</span><span class="p">:</span> <span class="n">dt</span><span class="p">,</span> <span class="n">end</span><span class="p">:</span> <span class="n">dt</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">export_data</span><span class="p">(</span><span class="n">exporter_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">start</span><span class="p">:</span> <span class="n">dt</span><span class="p">,</span> <span class="n">end</span><span class="p">:</span> <span class="n">dt</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Export data using the specified exporter.</span>
 
 <span class="sd">    Args:</span>
@@ -1270,7 +1259,7 @@ <h2 id="event_audit.cli.export_data" class="doc doc-heading">
 <span class="sd">            documentation for args details.</span>
 
 <span class="sd">    Returns:</span>
-<span class="sd">        str : The exported data</span>
+<span class="sd">        The exported data will be printed to the standard output.</span>
 
 <span class="sd">    Example:</span>
 <span class="sd">        $ ckan event-audit export-data csv --start=2024-11-11 &gt; report.csv</span>
@@ -1329,9 +1318,7 @@ <h2 id="event_audit.cli.remove_events" class="doc doc-heading">
       </thead>
       <tbody>
           <tr class="doc-section-item">
-            <td>
-                <code>repository</code>
-            </td>
+            <td><code>repository</code></td>
             <td class="doc-param-details">
               <div class="doc-md-description">
                 <p>The repository name. If not provided, the
@@ -1346,9 +1333,7 @@ <h2 id="event_audit.cli.remove_events" class="doc doc-heading">
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td>
-                <code>start</code>
-            </td>
+            <td><code>start</code></td>
             <td class="doc-param-details">
               <div class="doc-md-description">
                 <p>The start date string in %Y-%m-%d format.</p>
@@ -1362,9 +1347,7 @@ <h2 id="event_audit.cli.remove_events" class="doc doc-heading">
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td>
-                <code>end</code>
-            </td>
+            <td><code>end</code></td>
             <td class="doc-param-details">
               <div class="doc-md-description">
                 <p>The end date string in %Y-%m-%d format.</p>