mkdocstrings-github 0.4.3__tar.gz → 0.4.5__tar.gz

{mkdocstrings_github-0.4.3 → mkdocstrings_github-0.4.5}/.github/workflows/example_workflow.yml

@@ -5,7 +5,12 @@ on:
   workflow_call:
     inputs:
       environment:
-        description: 'Environment to deploy to'
+        description: |
+          Environment to deploy to. Must be one of 
+
+          - `development`
+          - `staging`
+          - `production`
         required: true
         type: string
       version:

{mkdocstrings_github-0.4.3 → mkdocstrings_github-0.4.5}/.gitignore

@@ -25,6 +25,7 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
+uv.lock
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

{mkdocstrings_github-0.4.3 → mkdocstrings_github-0.4.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-github
-Version: 0.4.3
+Version: 0.4.5
 Summary: A GitHub Action handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT

{mkdocstrings_github-0.4.3 → mkdocstrings_github-0.4.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocstrings-github"
-version = "0.4.3"
+version = "0.4.5"
 description = "A GitHub Action handler for mkdocstrings"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }
@@ -120,7 +120,7 @@ prerelease_token = "rc"
 prerelease = false
 
 [tool.semantic_release.commit_parser_options]
-patch_tags = ["fix", "perf", "chore"]
+patch_tags = ["fix", "perf", "chore", "refactor"]
 
 [tool.semantic_release.changelog]
 changelog_file = "docs/changelog.md"

{mkdocstrings_github-0.4.3 → mkdocstrings_github-0.4.5}/src/mkdocstrings_handlers/github/templates/material/action.html.jinja

@@ -7,7 +7,6 @@ Context:
   config (mkdocstrings_handlers.github.config.GitHubConfig): The global configuration
   options (dict): The local options
 -#}
-
 {% block logs scoped %}
   {#- Logging block.
 
@@ -28,15 +27,25 @@ Context:
   {% block signature scoped %}
     {% if options.show_signature %}
       {% with inputs = data.inputs | order_parameters(options.parameters_order) | filter_parameters(required=True) %}
+        <div class="annotate">
         {% filter highlight(language="yaml", inline=False, linenums=False) %}
           - uses: {{ signature }}
+          {% if inputs|length > 0 %}
             with:
-              {%+ for input in inputs %}{{ input.name }}: ''{% endfor +%}
+              {% for input in inputs %}
+              {{ input.name }}: ({{ loop.index }})
+              {% endfor %}
+          {% endif %}
         {% endfilter %}
+        </div>
+        <ol>
+        {% for input in inputs %}
+          <li>{{ input.description | convert_markdown(options.heading_level) if input.description else "(no description)" }}</li>
+        {% endfor %}
+        </ol>
       {% endwith %}
     {% endif %}
   {% endblock signature %}
-
   {% block description scoped %}
     {% if options.show_description %}
       {{ options.description if options.description else data.description | convert_markdown(options.heading_level, data.id) }}

{mkdocstrings_github-0.4.3 → mkdocstrings_github-0.4.5}/src/mkdocstrings_handlers/github/templates/material/workflow.html.jinja

@@ -24,29 +24,41 @@ Context:
 
   {% block signature scoped %}
     {% if options.show_signature %}
-      {% filter highlight(language="yaml", inline=False, linenums=False) %}
-        uses: {{ signature }}
-        {% if options.signature_show_permissions and data.permissions|length > 0 %}
-        permissions:
-          {% for scope, level in data.permissions | items %}
-          {{ scope }}: {{ level.label }}
-          {% endfor %}
-        {% endif %}
-        {% with inputs = data.inputs | order_parameters(options.parameters_order) | filter_parameters(required=True) %}
-        {% if inputs|length > 0 %}
-        with:
-          {%+ for input in inputs %}{{ input.name }}: ''{% endfor +%}
-        {% endif %}
-        {% endwith %}
-        {% if options.signature_show_secrets %}
-        {% with secrets = data.secrets | order_parameters(options.parameters_order) | filter_parameters(required=True) %}
-        {% if secrets|length > 0 %}
-        secrets:
-          {%+ for secret in secrets %}{{ secret.name }}: ''{% endfor +%}
-        {% endif %}
-        {% endwith %}
-        {% endif %}
-      {% endfilter %}
+      {% with inputs = data.inputs | order_parameters(options.parameters_order) | filter_parameters(required=True), secrets = data.secrets | order_parameters(options.parameters_order) | filter_parameters(required=True) %}
+        <div class="annotate">
+        {% filter highlight(language="yaml", inline=False, linenums=False) %}
+          uses: {{ signature }}
+          {% if options.signature_show_permissions and data.permissions|length > 0 %}
+          permissions:
+            {% for scope, level in data.permissions | items %}
+            {{ scope }}: {{ level.label }}
+            {% endfor %}
+          {% endif %}
+          {% if inputs|length > 0 %}
+          with:
+            {% for input in inputs %}
+            {{ input.name }}: ({{ loop.index }})
+            {% endfor %}
+          {% endif %}
+          {% if options.signature_show_secrets %}
+          {% if secrets|length > 0 %}
+          secrets:
+            {% for secret in secrets %}
+            {{ secret.name }}: ({{ inputs|length + loop.index }})
+            {% endfor %}
+          {% endif %}
+          {% endif %}
+        {% endfilter %}
+        </div>
+        <ol>
+        {% for input in inputs %}
+          <li>{{ input.description | convert_markdown(options.heading_level) if input.description else "(no description)" }}</li>
+        {% endfor %}
+        {% for secret in secrets %}
+          <li>{{ secret.description | convert_markdown(options.heading_level) if secret.description else "(no description)" }}</li>
+        {% endfor %}
+        </ol>
+      {% endwith %}
     {% endif %}
   {% endblock signature %}
 

{mkdocstrings_github-0.4.3 → mkdocstrings_github-0.4.5}/test/snapshots/__init__.py

@@ -10,7 +10,7 @@ workflow_show = snapshot(
             ("signature_version_string", ""),
             ("signature_show_secrets", True),
             ("signature_show_permissions", True),
-        ): external("hash:d2e25cb02f37*.html"),
+        ): external("hash:6d20fba34c55*.html"),
         (("show_description", True), ("description", ""), ("show_source", True)): external(
             "hash:78f74a133e98*.html"
         ),
@@ -49,14 +49,14 @@ workflow_show = snapshot(
             ("signature_version_string", ""),
             ("signature_show_secrets", True),
             ("signature_show_permissions", False),
-        ): external("hash:580dbb72a430*.html"),
+        ): external("hash:06f909d26ca3*.html"),
         (
             ("show_signature", True),
             ("signature_version", "string"),
             ("signature_version_string", "latest"),
             ("signature_show_secrets", False),
             ("signature_show_permissions", True),
-        ): external("hash:8df27f9a94e1*.html"),
+        ): external("hash:23cc1367f9dd*.html"),
         (
             ("show_signature", False),
             ("signature_version", "string"),
@@ -250,17 +250,17 @@ action_show = snapshot(
             ("show_signature", True),
             ("signature_version", "major"),
             ("signature_version_string", ""),
-        ): external("hash:37c546e4acea*.html"),
+        ): external("hash:94b8c0c6610d*.html"),
         (
             ("show_signature", True),
             ("signature_version", "semver"),
             ("signature_version_string", ""),
-        ): external("hash:5f8858f37fdd*.html"),
+        ): external("hash:ace14d7e4e53*.html"),
         (
             ("show_signature", True),
             ("signature_version", "string"),
             ("signature_version_string", "latest"),
-        ): external("hash:0c67cdd8572d*.html"),
+        ): external("hash:e567efbdae19*.html"),
         (
             ("show_signature", False),
             ("signature_version", "string"),

mkdocstrings_github-0.4.3/test/snapshots/external/580dbb72a43006671d311475eebd6a9473776f0637b33fd2dcef405dfe054567.html → mkdocstrings_github-0.4.5/test/snapshots/external/06f909d26ca3c2008ca57aeae14dc63fb04ade05997b8aed6ae1573bf42b5841.html

@@ -13,14 +13,28 @@
 <div class="doc doc-object doc-workflow">
  <h1 class="doc doc-heading" id=".github/workflows/reusable-workflow.yml">
  </h1>
- <div class="highlight">
-  <pre><span></span><code><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watermarkhu/mkdocstrings-github-fixture/.github/workflows/reusable-workflow.yml@v1.0.1</span>
+ <div class="annotate">
+  <div class="highlight">
+   <pre><span></span><code><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watermarkhu/mkdocstrings-github-fixture/.github/workflows/reusable-workflow.yml@v1.0.1</span>
 <span class="nt">with</span><span class="p">:</span>
-<span class="w">  </span><span class="nt">environment</span><span class="p">:</span><span class="w"> </span><span class="s">''</span>
+<span class="w">  </span><span class="nt">environment</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">(1)</span>
 <span class="nt">secrets</span><span class="p">:</span>
-<span class="w">  </span><span class="nt">API_KEY</span><span class="p">:</span><span class="w"> </span><span class="s">''</span>
+<span class="w">  </span><span class="nt">API_KEY</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">(2)</span>
 </code></pre>
+  </div>
  </div>
+ <ol>
+  <li>
+   <p>
+    Environment to deploy to
+   </p>
+  </li>
+  <li>
+   <p>
+    API key for external service
+   </p>
+  </li>
+ </ol>
 </div>
 <script>
  feather.replace()

mkdocstrings_github-0.4.3/test/snapshots/external/8df27f9a94e16efe5686ebeded8a93bd5b071f4d39fe47224ce218a6b1e58b90.html → mkdocstrings_github-0.4.5/test/snapshots/external/23cc1367f9dd06c1d51e4b1c8a5a2ea807f32a78de9c061438f4d2315bcc3d0e.html

@@ -13,17 +13,31 @@
 <div class="doc doc-object doc-workflow">
  <h1 class="doc doc-heading" id=".github/workflows/reusable-workflow.yml">
  </h1>
- <div class="highlight">
-  <pre><span></span><code><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watermarkhu/mkdocstrings-github-fixture/.github/workflows/reusable-workflow.yml@latest</span>
+ <div class="annotate">
+  <div class="highlight">
+   <pre><span></span><code><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watermarkhu/mkdocstrings-github-fixture/.github/workflows/reusable-workflow.yml@latest</span>
 <span class="nt">permissions</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">contents</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">read</span>
 <span class="w">  </span><span class="nt">deployments</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">write</span>
 <span class="w">  </span><span class="nt">pull-requests</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">write</span>
 <span class="w">  </span><span class="nt">issues</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">read</span>
 <span class="nt">with</span><span class="p">:</span>
-<span class="w">  </span><span class="nt">environment</span><span class="p">:</span><span class="w"> </span><span class="s">''</span>
+<span class="w">  </span><span class="nt">environment</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">(1)</span>
 </code></pre>
+  </div>
  </div>
+ <ol>
+  <li>
+   <p>
+    Environment to deploy to
+   </p>
+  </li>
+  <li>
+   <p>
+    API key for external service
+   </p>
+  </li>
+ </ol>
 </div>
 <script>
  feather.replace()

mkdocstrings_github-0.4.3/test/snapshots/external/d2e25cb02f371db9bd247a36766f7887ef1d2adad97ba1102ab1d98cf3128dc3.html → mkdocstrings_github-0.4.5/test/snapshots/external/6d20fba34c55a0c3c25d29a29470de573812305d70dabac3104a7d18d92b2b86.html

@@ -13,19 +13,33 @@
 <div class="doc doc-object doc-workflow">
  <h1 class="doc doc-heading" id=".github/workflows/reusable-workflow.yml">
  </h1>
- <div class="highlight">
-  <pre><span></span><code><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watermarkhu/mkdocstrings-github-fixture/.github/workflows/reusable-workflow.yml@v1</span>
+ <div class="annotate">
+  <div class="highlight">
+   <pre><span></span><code><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watermarkhu/mkdocstrings-github-fixture/.github/workflows/reusable-workflow.yml@v1</span>
 <span class="nt">permissions</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">contents</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">read</span>
 <span class="w">  </span><span class="nt">deployments</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">write</span>
 <span class="w">  </span><span class="nt">pull-requests</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">write</span>
 <span class="w">  </span><span class="nt">issues</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">read</span>
 <span class="nt">with</span><span class="p">:</span>
-<span class="w">  </span><span class="nt">environment</span><span class="p">:</span><span class="w"> </span><span class="s">''</span>
+<span class="w">  </span><span class="nt">environment</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">(1)</span>
 <span class="nt">secrets</span><span class="p">:</span>
-<span class="w">  </span><span class="nt">API_KEY</span><span class="p">:</span><span class="w"> </span><span class="s">''</span>
+<span class="w">  </span><span class="nt">API_KEY</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">(2)</span>
 </code></pre>
+  </div>
  </div>
+ <ol>
+  <li>
+   <p>
+    Environment to deploy to
+   </p>
+  </li>
+  <li>
+   <p>
+    API key for external service
+   </p>
+  </li>
+ </ol>
 </div>
 <script>
  feather.replace()

mkdocstrings_github-0.4.3/test/snapshots/external/37c546e4aceaf4af0a681bdaa444b8be901c78713e762fd96d2237b8a78811c5.html → mkdocstrings_github-0.4.5/test/snapshots/external/94b8c0c6610d32e8a877cb18b47ff8b072203c6a1e8fddc67be1d7e5b963c385.html

@@ -11,12 +11,21 @@
 <div class="doc doc-object doc-action">
  <h1 class="doc doc-heading" id=".">
  </h1>
- <div class="highlight">
-  <pre><span></span><code><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watermarkhu/mkdocstrings-github-fixture@v1</span>
+ <div class="annotate">
+  <div class="highlight">
+   <pre><span></span><code><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watermarkhu/mkdocstrings-github-fixture@v1</span>
 <span class="w">  </span><span class="nt">with</span><span class="p">:</span>
-<span class="w">    </span><span class="nt">input-string</span><span class="p">:</span><span class="w"> </span><span class="s">''</span>
+<span class="w">    </span><span class="nt">input-string</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">(1)</span>
 </code></pre>
+  </div>
  </div>
+ <ol>
+  <li>
+   <p>
+    A string input parameter
+   </p>
+  </li>
+ </ol>
 </div>
 <script>
  feather.replace()

mkdocstrings_github-0.4.3/test/snapshots/external/5f8858f37fdd6904be6fa07c66a28b0970f569174cab5087c28c710cac24cd92.html → mkdocstrings_github-0.4.5/test/snapshots/external/ace14d7e4e53515a281c109aca1d7b5bccb1259ff0c3e0c28a8e09908e4f2f26.html

@@ -11,12 +11,21 @@
 <div class="doc doc-object doc-action">
  <h1 class="doc doc-heading" id=".">
  </h1>
- <div class="highlight">
-  <pre><span></span><code><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watermarkhu/mkdocstrings-github-fixture@v1.0.1</span>
+ <div class="annotate">
+  <div class="highlight">
+   <pre><span></span><code><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watermarkhu/mkdocstrings-github-fixture@v1.0.1</span>
 <span class="w">  </span><span class="nt">with</span><span class="p">:</span>
-<span class="w">    </span><span class="nt">input-string</span><span class="p">:</span><span class="w"> </span><span class="s">''</span>
+<span class="w">    </span><span class="nt">input-string</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">(1)</span>
 </code></pre>
+  </div>
  </div>
+ <ol>
+  <li>
+   <p>
+    A string input parameter
+   </p>
+  </li>
+ </ol>
 </div>
 <script>
  feather.replace()

mkdocstrings_github-0.4.3/test/snapshots/external/0c67cdd8572de4a97d061f099552f428affde9f418d962c119559531a92f57aa.html → mkdocstrings_github-0.4.5/test/snapshots/external/e567efbdae19280c4c56a70a27de39e0efdc422d99c9d497629128fd3ec553d5.html

@@ -11,12 +11,21 @@
 <div class="doc doc-object doc-action">
  <h1 class="doc doc-heading" id=".">
  </h1>
- <div class="highlight">
-  <pre><span></span><code><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watermarkhu/mkdocstrings-github-fixture@latest</span>
+ <div class="annotate">
+  <div class="highlight">
+   <pre><span></span><code><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">watermarkhu/mkdocstrings-github-fixture@latest</span>
 <span class="w">  </span><span class="nt">with</span><span class="p">:</span>
-<span class="w">    </span><span class="nt">input-string</span><span class="p">:</span><span class="w"> </span><span class="s">''</span>
+<span class="w">    </span><span class="nt">input-string</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">(1)</span>
 </code></pre>
+  </div>
  </div>
+ <ol>
+  <li>
+   <p>
+    A string input parameter
+   </p>
+  </li>
+ </ol>
 </div>
 <script>
  feather.replace()