mkdocstrings-github 0.2.6__py3-none-any.whl → 0.3.0__py3-none-any.whl

{mkdocstrings_github-0.2.6.dist-info → mkdocstrings_github-0.3.0.dist-info}/METADATA

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

{mkdocstrings_github-0.2.6.dist-info → mkdocstrings_github-0.3.0.dist-info}/RECORD

@@ -1,17 +1,17 @@
 mkdocstrings_handlers/github/__init__.py,sha256=0WdFUIq4Xu2ZFtlZNIYCQSoqcx3Ot9Wv41_X_dwbFww,248
 mkdocstrings_handlers/github/config.py,sha256=IxD1AiaQf3wC2cRabi3wUriimZDOhFOmpWw5CB-jSb4,6277
-mkdocstrings_handlers/github/handler.py,sha256=gNmKpMfr1xc6WIlCZh3J3Oz9BAKDKvAsPJZt2C2oJWg,10813
+mkdocstrings_handlers/github/handler.py,sha256=KjZJAq_wELYhBTMZgkWugsaNhBJFlidmFe_9cddxCuo,11028
 mkdocstrings_handlers/github/objects.py,sha256=JDkY7mg_LGlIEwZHP2wSd8ZkB6RVtRsu_JEpwV-PikQ,7069
 mkdocstrings_handlers/github/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mkdocstrings_handlers/github/rendering.py,sha256=8h5Zn62b3od9Dj3MNvMtAGg_ZyyLfJKv2Z2qGdFaKG8,2329
+mkdocstrings_handlers/github/rendering.py,sha256=tJeAsSaijqSC2IkxYsIXq7d0lR2A3aB5PRUcFFTFpVU,2705
 mkdocstrings_handlers/github/templates/material/action.html.jinja,sha256=87NCgz-zY16rU7tEmJETJ0gLwdzxoBrqLtp9vsVCsiw,2435
 mkdocstrings_handlers/github/templates/material/heading.html.jinja,sha256=wnvZpNED8Dhb935qnddeDExXN-MIUz8frRRfgq-A9VA,1396
-mkdocstrings_handlers/github/templates/material/inputs.html.jinja,sha256=pRd2grqaExOZniRxPDyVrtwX0lzLV-RdOvI6E_PBTBM,3144
-mkdocstrings_handlers/github/templates/material/outputs.html.jinja,sha256=ePu1v873RbJx5lS1Y4L-K5eNNEwCTiW-TCmxKn-DxvI,2572
-mkdocstrings_handlers/github/templates/material/secrets.html.jinja,sha256=92ynVoZinsLEp7_sFS3mL2E2ngOXPPAtXzGAuGFvhmY,2782
+mkdocstrings_handlers/github/templates/material/inputs.html.jinja,sha256=CIcw3OBQdCP4e5A4srLu1v3xoOjsedIw1Zh3qxtG0-A,3482
+mkdocstrings_handlers/github/templates/material/outputs.html.jinja,sha256=jlzVF93q5AyJfOiSl3_1VBVL3c6rjmEcS81s3sri5Gg,2670
+mkdocstrings_handlers/github/templates/material/secrets.html.jinja,sha256=1lMJoxjjeiqetVu0mdLKmZ1faYRReeyjiYvYTZESots,2881
 mkdocstrings_handlers/github/templates/material/style.css,sha256=R2hh1RfHwJ6XNT4YQl_txNkNXcPBZJMCBZn5kQEMQ6M,962
 mkdocstrings_handlers/github/templates/material/workflow.html.jinja,sha256=E1VUi2w7_NDkpS9VNrWRV52hhyhQvnKUrjPbV_j0Qcg,3312
-mkdocstrings_github-0.2.6.dist-info/METADATA,sha256=bJFvjA8hX48033Nzh6foiStVEZ-YOCNGt2rje03pKmo,3125
-mkdocstrings_github-0.2.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-mkdocstrings_github-0.2.6.dist-info/licenses/LICENSE,sha256=5enZtJ4zSp0Ps3jTqFQ4kadcx62BhgTaDNPrXWb3g3E,1069
-mkdocstrings_github-0.2.6.dist-info/RECORD,,
+mkdocstrings_github-0.3.0.dist-info/METADATA,sha256=MQyoPBfAXQXy8Lsc8PA_GSo1s1OQlWffozEo7Jx-M_k,3125
+mkdocstrings_github-0.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+mkdocstrings_github-0.3.0.dist-info/licenses/LICENSE,sha256=5enZtJ4zSp0Ps3jTqFQ4kadcx62BhgTaDNPrXWb3g3E,1069
+mkdocstrings_github-0.3.0.dist-info/RECORD,,

mkdocstrings_handlers/github/handler.py

@@ -180,8 +180,10 @@ class GitHubHandler(BaseHandler):
         for release in releases:
             tag = release.tag_name
             if not self.semver and SEMVER_PATTERN.match(tag):
+                _logger.info(f"Using GitHub release tag '{tag}' for semver.")
                 self.semver = tag
             if not self.major and MAJOR_PATTERN.match(tag):
+                _logger.info(f"Using GitHub release tag '{tag}' for major.")
                 self.major = tag
             if self.semver and self.major:
                 break
@@ -223,6 +225,7 @@ class GitHubHandler(BaseHandler):
         self.env.filters["order_parameters"] = rendering.order_parameters
         self.env.filters["filter_parameters"] = rendering.filter_parameters
         self.env.filters["anchor_id"] = rendering.anchor_id
+        self.env.filters["as_string"] = rendering.as_string
         self.env.globals["semver_tag"] = self.semver
         self.env.globals["major_tag"] = self.major
         self.env.globals["git_repo"] = self.repo

mkdocstrings_handlers/github/rendering.py

@@ -72,3 +72,17 @@ def filter_parameters(
 def anchor_id(name: str, prefix: str, parent_id: str) -> str:
     anchor = f"{parent_id}--{prefix}.{name}"
     return anchor.replace(" ", "-")
+
+
+def as_string(value: bool | str | int | float | None) -> str:
+    match value:
+        case bool():
+            return "true" if value else "false"
+        case str():
+            return value
+        case int() | float():
+            return str(value)
+        case None:
+            return ""
+        case _:
+            raise TypeError(f"Unsupported type: {type(value)}")

mkdocstrings_handlers/github/templates/material/inputs.html.jinja

@@ -11,10 +11,16 @@ Context:
   {{ log.debug("Rendering inputs of " + data.id) }}
 {% endblock logs %}
 
+{# If there are no inputs, do not render anything. #}
+{% if inputs | length > 0 %}
+
 {% set header_id -%}
   inputs-{{ data.id | replace('/', '-') | replace('.', '') | lower }}
 {%- endset %}
 
+{% set default_column = inputs | selectattr("default") | list | length > 0 %}
+
+{# Render the inputs section #}
 {% if options.parameters_section_style == "table" %}
   {% block table_style scoped %}
     <p>
@@ -26,7 +32,7 @@ Context:
         <tr>
           <th>Name</th>
           <th>Description</th>
-          <th>Default</th>
+          {% if default_column %}<th>Default</th>{% endif %}
         </tr>
       </thead>
       <tbody>
@@ -50,11 +56,13 @@ Context:
             <td>
               {{ input.description | convert_markdown(options.heading_level, data.id) }}
             </td>
+            {% if default_column %}
             <td>
-              {% if input.default %}
-                <code>{{ input.default }}</code>
+              {% if input.default is not none %}
+                <code>{{ input.default | as_string }}</code>
               {% endif %}
             </td>
+            {% endif %}
           </tr>
         {% endfor %}
       </tbody>
@@ -80,7 +88,7 @@ Context:
           </div>
           {% if input.default is not none %}
             <div class="doc-md-description">
-              Default: <code>{{ input.default }}</code>
+              Default: <code>{{ input.default | as_string }}</code>
             </div>
           {% endif %}
         </li>
@@ -88,3 +96,5 @@ Context:
     </ul>
   {% endblock list_style %}
 {% endif %}
+
+{% endif %}

mkdocstrings_handlers/github/templates/material/outputs.html.jinja

@@ -11,6 +11,9 @@ Context:
   {{ log.debug("Rendering outputs of " + data.id) }}
 {% endblock logs %}
 
+{# If there are no outputs, do not render anything. #}
+{% if outputs | length > 0 %}
+
 {% set header_id -%}
   outputs-{{ data.id | replace('/', '-') | replace('.', '') | lower }}
 {%- endset %}
@@ -72,3 +75,4 @@ Context:
   {% endblock list_style %}
 {% endif %}
 
+{% endif %}

mkdocstrings_handlers/github/templates/material/secrets.html.jinja

@@ -11,6 +11,9 @@ Context:
   {{ log.debug("Rendering secrets of " + data.id) }}
 {% endblock logs %}
 
+{# If there are no secrets, do not render anything. #}
+{% if secrets | length > 0 %}
+
 {% set header_id -%}
   secrets-{{ data.id | replace('/', '-') | replace('.', '') | lower }}
 {%- endset %}
@@ -76,3 +79,5 @@ Context:
     </ul>
   {% endblock list_style %}
 {% endif %}
+
+{% endif %}