mkdocstrings-github 0.4.3__py3-none-any.whl → 0.4.5__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. {mkdocstrings_github-0.4.3.dist-info → mkdocstrings_github-0.4.5.dist-info}/METADATA +1 -1
  2. {mkdocstrings_github-0.4.3.dist-info → mkdocstrings_github-0.4.5.dist-info}/RECORD +6 -6
  3. mkdocstrings_handlers/github/templates/material/action.html.jinja +12 -3
  4. mkdocstrings_handlers/github/templates/material/workflow.html.jinja +35 -23
  5. {mkdocstrings_github-0.4.3.dist-info → mkdocstrings_github-0.4.5.dist-info}/WHEEL +0 -0
  6. {mkdocstrings_github-0.4.3.dist-info → mkdocstrings_github-0.4.5.dist-info}/licenses/LICENSE +0 -0
{mkdocstrings_github-0.4.3.dist-info → mkdocstrings_github-0.4.5.dist-info}/METADATA RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: mkdocstrings-github
3
- Version: 0.4.3
3
+ Version: 0.4.5
4
4
  Summary: A GitHub Action handler for mkdocstrings
5
5
  Author-email: Mark Hu <watermarkhu@gmail.com>
6
6
  License: MIT
{mkdocstrings_github-0.4.3.dist-info → mkdocstrings_github-0.4.5.dist-info}/RECORD RENAMED
@@ -4,14 +4,14 @@ mkdocstrings_handlers/github/handler.py,sha256=QJbZjRbllUuGs5rY6SLwaII6hsPQnioa_
4
4
  mkdocstrings_handlers/github/objects.py,sha256=JDkY7mg_LGlIEwZHP2wSd8ZkB6RVtRsu_JEpwV-PikQ,7069
5
5
  mkdocstrings_handlers/github/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
6
6
  mkdocstrings_handlers/github/rendering.py,sha256=6xcE2WwyTRW_38g7Ek55hlm53EsFFqueazFw12__DyA,2820
7
- mkdocstrings_handlers/github/templates/material/action.html.jinja,sha256=87NCgz-zY16rU7tEmJETJ0gLwdzxoBrqLtp9vsVCsiw,2435
7
+ mkdocstrings_handlers/github/templates/material/action.html.jinja,sha256=rCzKrkLyUiD3jKODjQcBDsC-eq2KKvTQ6t3JgUmpm_k,2794
8
8
  mkdocstrings_handlers/github/templates/material/heading.html.jinja,sha256=wnvZpNED8Dhb935qnddeDExXN-MIUz8frRRfgq-A9VA,1396
9
9
  mkdocstrings_handlers/github/templates/material/inputs.html.jinja,sha256=CIcw3OBQdCP4e5A4srLu1v3xoOjsedIw1Zh3qxtG0-A,3482
10
10
  mkdocstrings_handlers/github/templates/material/outputs.html.jinja,sha256=jlzVF93q5AyJfOiSl3_1VBVL3c6rjmEcS81s3sri5Gg,2670
11
11
  mkdocstrings_handlers/github/templates/material/secrets.html.jinja,sha256=1lMJoxjjeiqetVu0mdLKmZ1faYRReeyjiYvYTZESots,2881
12
12
  mkdocstrings_handlers/github/templates/material/style.css,sha256=R2hh1RfHwJ6XNT4YQl_txNkNXcPBZJMCBZn5kQEMQ6M,962
13
- mkdocstrings_handlers/github/templates/material/workflow.html.jinja,sha256=89hEu1dagyqEV_40iTeCR4UKvdI4HlIJaUAebqugxNM,3400
14
- mkdocstrings_github-0.4.3.dist-info/METADATA,sha256=0G1SP3Qs5hbC6rPz32iZ1uJT-jnaFq6X7pWNUfeHLnc,3340
15
- mkdocstrings_github-0.4.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
16
- mkdocstrings_github-0.4.3.dist-info/licenses/LICENSE,sha256=5enZtJ4zSp0Ps3jTqFQ4kadcx62BhgTaDNPrXWb3g3E,1069
17
- mkdocstrings_github-0.4.3.dist-info/RECORD,,
13
+ mkdocstrings_handlers/github/templates/material/workflow.html.jinja,sha256=OLFnkkX0bxVwIksZ_hf9ujMnns2nwV2df0vIrn1ly-U,3937
14
+ mkdocstrings_github-0.4.5.dist-info/METADATA,sha256=C6T2gQ9mAp6RpIHLsLyQyucWn131bzPanwP1hHBn40I,3340
15
+ mkdocstrings_github-0.4.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
16
+ mkdocstrings_github-0.4.5.dist-info/licenses/LICENSE,sha256=5enZtJ4zSp0Ps3jTqFQ4kadcx62BhgTaDNPrXWb3g3E,1069
17
+ mkdocstrings_github-0.4.5.dist-info/RECORD,,
mkdocstrings_handlers/github/templates/material/action.html.jinja CHANGED
@@ -7,7 +7,6 @@ Context:
7
7
  config (mkdocstrings_handlers.github.config.GitHubConfig): The global configuration
8
8
  options (dict): The local options
9
9
  -#}
10
-
11
10
  {% block logs scoped %}
12
11
  {#- Logging block.
13
12
 
@@ -28,15 +27,25 @@ Context:
28
27
  {% block signature scoped %}
29
28
  {% if options.show_signature %}
30
29
  {% with inputs = data.inputs | order_parameters(options.parameters_order) | filter_parameters(required=True) %}
30
+ <div class="annotate">
31
31
  {% filter highlight(language="yaml", inline=False, linenums=False) %}
32
32
  - uses: {{ signature }}
33
+ {% if inputs|length > 0 %}
33
34
  with:
34
- {%+ for input in inputs %}{{ input.name }}: ''{% endfor +%}
35
+ {% for input in inputs %}
36
+ {{ input.name }}: ({{ loop.index }})
37
+ {% endfor %}
38
+ {% endif %}
35
39
  {% endfilter %}
40
+ </div>
41
+ <ol>
42
+ {% for input in inputs %}
43
+ <li>{{ input.description | convert_markdown(options.heading_level) if input.description else "(no description)" }}</li>
44
+ {% endfor %}
45
+ </ol>
36
46
  {% endwith %}
37
47
  {% endif %}
38
48
  {% endblock signature %}
39
-
40
49
  {% block description scoped %}
41
50
  {% if options.show_description %}
42
51
  {{ options.description if options.description else data.description | convert_markdown(options.heading_level, data.id) }}
mkdocstrings_handlers/github/templates/material/workflow.html.jinja CHANGED
@@ -24,29 +24,41 @@ Context:
24
24
 
25
25
  {% block signature scoped %}
26
26
  {% if options.show_signature %}
27
- {% filter highlight(language="yaml", inline=False, linenums=False) %}
28
- uses: {{ signature }}
29
- {% if options.signature_show_permissions and data.permissions|length > 0 %}
30
- permissions:
31
- {% for scope, level in data.permissions | items %}
32
- {{ scope }}: {{ level.label }}
33
- {% endfor %}
34
- {% endif %}
35
- {% with inputs = data.inputs | order_parameters(options.parameters_order) | filter_parameters(required=True) %}
36
- {% if inputs|length > 0 %}
37
- with:
38
- {%+ for input in inputs %}{{ input.name }}: ''{% endfor +%}
39
- {% endif %}
40
- {% endwith %}
41
- {% if options.signature_show_secrets %}
42
- {% with secrets = data.secrets | order_parameters(options.parameters_order) | filter_parameters(required=True) %}
43
- {% if secrets|length > 0 %}
44
- secrets:
45
- {%+ for secret in secrets %}{{ secret.name }}: ''{% endfor +%}
46
- {% endif %}
47
- {% endwith %}
48
- {% endif %}
49
- {% endfilter %}
27
+ {% 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) %}
28
+ <div class="annotate">
29
+ {% filter highlight(language="yaml", inline=False, linenums=False) %}
30
+ uses: {{ signature }}
31
+ {% if options.signature_show_permissions and data.permissions|length > 0 %}
32
+ permissions:
33
+ {% for scope, level in data.permissions | items %}
34
+ {{ scope }}: {{ level.label }}
35
+ {% endfor %}
36
+ {% endif %}
37
+ {% if inputs|length > 0 %}
38
+ with:
39
+ {% for input in inputs %}
40
+ {{ input.name }}: ({{ loop.index }})
41
+ {% endfor %}
42
+ {% endif %}
43
+ {% if options.signature_show_secrets %}
44
+ {% if secrets|length > 0 %}
45
+ secrets:
46
+ {% for secret in secrets %}
47
+ {{ secret.name }}: ({{ inputs|length + loop.index }})
48
+ {% endfor %}
49
+ {% endif %}
50
+ {% endif %}
51
+ {% endfilter %}
52
+ </div>
53
+ <ol>
54
+ {% for input in inputs %}
55
+ <li>{{ input.description | convert_markdown(options.heading_level) if input.description else "(no description)" }}</li>
56
+ {% endfor %}
57
+ {% for secret in secrets %}
58
+ <li>{{ secret.description | convert_markdown(options.heading_level) if secret.description else "(no description)" }}</li>
59
+ {% endfor %}
60
+ </ol>
61
+ {% endwith %}
50
62
  {% endif %}
51
63
  {% endblock signature %}
52
64