doc: add validators doc

DataShades · Nov 19, 2024 · 49525e0 · 49525e0
1 parent 7a2192a
commit 49525e0
Show file tree

Hide file tree

Showing 32 changed files with 2,097 additions and 544 deletions.
diff --git a/ckanext/event_audit/logic/validators.py b/ckanext/event_audit/logic/validators.py
@@ -9,7 +9,32 @@
 
 
 def audit_repo_exists(value: Any, context: Context) -> Any:
+    """Check if the repository with the given name is registered.
+
+    Args:
+        value (Any): The repository name.
+        context (Context): The CKAN context.
+
+    Returns:
+        Any: The repository name if it exists.
+
+    Raises:
+        tk.Invalid: If the repository does not exist.
+    """
     if value not in utils.get_available_repos():
         raise tk.Invalid(f"Repository `{value}` is not registered")
 
     return value
+
+def add_numbers(a: int, b: int) -> int:
+    """
+    Add two numbers.
+
+    Args:
+        a (int): The first number.
+        b (int): The second number.
+
+    Returns:
+        int: The sum of the two numbers.
+    """
+    return a + b
diff --git a/docs/validators.md b/docs/validators.md
@@ -0,0 +1,6 @@
+# Validators
+
+::: event_audit.logic.validators.audit_repo_exists
+    options:
+      show_source: true
+      show_root_heading: true
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -83,6 +83,7 @@ nav:
   - install.md
   - usage.md
   - interfaces.md
+  - validators.md
   - utils.md
 
   - Configuration:

diff --git a/site/404.html b/site/404.html
@@ -12,7 +12,7 @@
 
 
       <link rel="icon" href="/ckanext-event-audit/img/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.44">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">
 
 
 
@@ -331,6 +331,26 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="/ckanext-event-audit/validators/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Validators
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="/ckanext-event-audit/utils/" class="md-nav__link">
 
@@ -371,10 +391,10 @@
 
 
 
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
 
 
-          <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
 
 
   <span class="md-ellipsis">
@@ -385,8 +405,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
 
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_6">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_7">
             <span class="md-nav__icon md-icon"></span>
             Configuration
           </label>
@@ -530,10 +550,10 @@
 
 
 
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
 
 
-          <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
 
 
   <span class="md-ellipsis">
@@ -544,8 +564,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
 
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_7">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_8">
             <span class="md-nav__icon md-icon"></span>
             Exporters
           </label>
@@ -691,10 +711,10 @@
 
 
 
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" >
 
 
-          <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="0">
 
 
   <span class="md-ellipsis">
@@ -705,8 +725,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
 
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_8">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_9">
             <span class="md-nav__icon md-icon"></span>
             Repositories
           </label>

diff --git a/site/assets/_mkdocstrings.css b/site/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/site/configure/active_repo/index.html b/site/configure/active_repo/index.html
@@ -18,7 +18,7 @@
 
 
       <link rel="icon" href="../../img/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.44">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">
 
 
 
@@ -342,6 +342,26 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../../validators/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Validators
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="../../utils/" class="md-nav__link">
 
@@ -384,10 +404,10 @@
 
 
 
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" checked>
 
 
-          <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
 
 
   <span class="md-ellipsis">
@@ -398,8 +418,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
 
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_6">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_7">
             <span class="md-nav__icon md-icon"></span>
             Configuration
           </label>
@@ -553,10 +573,10 @@
 
 
 
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
 
 
-          <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
 
 
   <span class="md-ellipsis">
@@ -567,8 +587,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
 
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_7">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_8">
             <span class="md-nav__icon md-icon"></span>
             Exporters
           </label>
@@ -714,10 +734,10 @@
 
 
 
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" >
 
 
-          <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="0">
 
 
   <span class="md-ellipsis">
@@ -728,8 +748,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
 
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_8">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_9">
             <span class="md-nav__icon md-icon"></span>
             Repositories
           </label>