mkdocstrings-github 0.1.0__tar.gz → 0.2.1__tar.gz

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 (105) hide show
  1. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/.github/workflows/docs.yaml +13 -6
  2. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/.github/workflows/example_workflow.yml +1 -1
  3. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/.github/workflows/release.yaml +1 -1
  4. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/PKG-INFO +2 -1
  5. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/README.md +1 -0
  6. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/docs/usage/general.md +1 -1
  7. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/docs/usage/headings.md +1 -1
  8. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/docs/usage/index.md +15 -2
  9. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/docs/usage/parameters.md +8 -2
  10. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/docs/usage/signatures.md +20 -1
  11. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/mkdocs.yml +3 -1
  12. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/pyproject.toml +2 -4
  13. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/src/mkdocstrings_handlers/github/config.py +11 -3
  14. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/src/mkdocstrings_handlers/github/handler.py +42 -5
  15. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/src/mkdocstrings_handlers/github/objects.py +8 -0
  16. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/src/mkdocstrings_handlers/github/rendering.py +5 -0
  17. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/src/mkdocstrings_handlers/github/templates/material/inputs.html.jinja +3 -7
  18. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/src/mkdocstrings_handlers/github/templates/material/outputs.html.jinja +3 -7
  19. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/src/mkdocstrings_handlers/github/templates/material/secrets.html.jinja +3 -7
  20. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/__init__.py +16 -16
  21. mkdocstrings_github-0.1.0/test/snapshots/external/99ee5da4993d42e07e7eab1d60e6115964ccc561452cc45a14b9dc82ac9c3d4c.html → mkdocstrings_github-0.2.1/test/snapshots/external/0ef4f0725dafdff18802cd0dd8839c35562755c90458f0dd3ef7743e87efdd89.html +8 -8
  22. mkdocstrings_github-0.1.0/test/snapshots/external/5a31bebe73cd8ed80c746895791e7f86388025353e218a47313a624d9baabba1.html → mkdocstrings_github-0.2.1/test/snapshots/external/24dfcb59a486346316de8203f742d4f3dd9129f9a57252c37741ad27d0eaddd7.html +8 -8
  23. mkdocstrings_github-0.1.0/test/snapshots/external/ce8c324c6d38bbf0288dfce2294d90beb4dc9cc07f2102407b2d12e2ad512dcc.html → mkdocstrings_github-0.2.1/test/snapshots/external/27b0437dc257c9970044eb25da334453829a4ae0450e98cf7a965aff5ad7fcba.html +2 -2
  24. mkdocstrings_github-0.1.0/test/snapshots/external/9536cc7cfc7602aa2e1b4c28065dce1ec17093f651a54487924f4b44da46a456.html → mkdocstrings_github-0.2.1/test/snapshots/external/293f8ca976970a4fb9549b1bd3b6f6be8a13bd86d9c34bb98813def62a5777aa.html +16 -16
  25. mkdocstrings_github-0.1.0/test/snapshots/external/7d6a6f97b26c6cdfa165705dfe1d98f53a4ccc95c61e8abaff9170023ab9ed92.html → mkdocstrings_github-0.2.1/test/snapshots/external/62440ee595f9a66c9c38e2dd31dd0333a03332893c982993b48c6e8e9074b5be.html +11 -11
  26. mkdocstrings_github-0.1.0/test/snapshots/external/314a0e4ec3973281d739eb032c0a75c88acb5bc8f07f1850cbda9c671872cf68.html → mkdocstrings_github-0.2.1/test/snapshots/external/84f918940f7b729b21a97d971a27bf994b2deb8ee5d9909481d98f702dfec96a.html +2 -2
  27. mkdocstrings_github-0.1.0/test/snapshots/external/cb58c01daaeb1cb7a8a60ab70c2ef5437dfad2dca1b03979840007250b288ab0.html → mkdocstrings_github-0.2.1/test/snapshots/external/a5c25b6859cc07004c872762d51e1c17d597a5d9cf4f325f0d876cafc3096d16.html +22 -22
  28. mkdocstrings_github-0.1.0/test/snapshots/external/8648f88cc21285340ba689e1c50b1799bfbf78cf1f65a76fc6d72a87b6ccf0ab.html → mkdocstrings_github-0.2.1/test/snapshots/external/b3235de10ed47f4d1a0d1d5fec8deb8323199b703201cc3a525950411079672b.html +2 -2
  29. mkdocstrings_github-0.1.0/test/snapshots/external/af4931df88d0f732f8efc3424e5a107e3649f43fbb493cabc262265a749cf77c.html → mkdocstrings_github-0.2.1/test/snapshots/external/bbea0ecf08aec9444ed75cbffd5424aa19e285ac64a53d1bb50f6130230b3c97.html +1 -1
  30. mkdocstrings_github-0.1.0/test/snapshots/external/c00418e99257195a45e48e6dbb589af808c59bb0ca65114a40e93ffa2e2e192f.html → mkdocstrings_github-0.2.1/test/snapshots/external/c8601796046ec0837b1cc98f777d45532e7c2c36606b8682536e0aac3f678554.html +22 -22
  31. mkdocstrings_github-0.1.0/test/snapshots/external/92bd52ad97f575a5adfdef9ead6a002fd23c4e70617f0a8f2c7421c92a45af1c.html → mkdocstrings_github-0.2.1/test/snapshots/external/d0d656ae32436d7b190665f98f3fe2d7a6250ee7ff4e1fb1bcd9a1364d3da2cb.html +1 -1
  32. mkdocstrings_github-0.1.0/test/snapshots/external/0cb5db6b0e9e1de8c4216943366f7d9e73757bee31862c073f2b0c56a60f3770.html → mkdocstrings_github-0.2.1/test/snapshots/external/dbb6b804e35c3cf48b6ea556486a82cf6f34af4d7cc455bfc02995969f45d09f.html +1 -1
  33. mkdocstrings_github-0.1.0/test/snapshots/external/4b4fbfc27652a05d769615c63eeac28b978b0ea46f3ba399914b82da3302e68e.html → mkdocstrings_github-0.2.1/test/snapshots/external/e5a8b4ccf8097faf7e34c1a90377932fad0277a6b89675ef7b9e05fa37fae38c.html +11 -11
  34. mkdocstrings_github-0.1.0/test/snapshots/external/73064e20f309fe267eb23ea59326f36270f7996ef45cef87cb76e7d4f1314277.html → mkdocstrings_github-0.2.1/test/snapshots/external/f0d6c0adbfcc02896663bc47e38910252279cabfe89c8c196c23f02b7d65d77d.html +1 -1
  35. mkdocstrings_github-0.1.0/test/snapshots/external/25090fe68096625113439c08824c4ec74f4487aa7dfaf3c2662824b1e19d0dda.html → mkdocstrings_github-0.2.1/test/snapshots/external/f575eacc0b72560cfc4e759f838f4ba8fc6ad1ee88d56fa707a1a840baf3e679.html +16 -16
  36. mkdocstrings_github-0.1.0/test/snapshots/external/3f50016a2686f5cf159a101caad52547914a0247258ea5565e919367c2574363.html → mkdocstrings_github-0.2.1/test/snapshots/external/fab6f055074f9b57075eb9f63d7a2f6ce6eb7ae6c5289a675cb24e507f3f5fb5.html +2 -2
  37. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/uv.lock +1 -1
  38. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/.github/CODEOWNERS +0 -0
  39. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/.github/CONTRIBUTING.md +0 -0
  40. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/.github/FUNDING.yml +0 -0
  41. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/.github/renovate.json5 +0 -0
  42. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/.github/workflows/qualify.yaml +0 -0
  43. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/.gitignore +0 -0
  44. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/.gitmodules +0 -0
  45. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/.pre-commit-config.yaml +0 -0
  46. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/CHANGELOG.md +0 -0
  47. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/LICENSE +0 -0
  48. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/action.yaml +0 -0
  49. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/docs/changelog.md +0 -0
  50. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/docs/contributing.md +0 -0
  51. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/docs/credits.md +0 -0
  52. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/docs/favicon.png +0 -0
  53. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/docs/index.md +0 -0
  54. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/docs/license-page.md +0 -0
  55. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/docs/logo.png +0 -0
  56. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/docs/overrides/main.html +0 -0
  57. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/docs/overrides/partials/toc-item.html +0 -0
  58. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/docs/stylesheets/extra.css +0 -0
  59. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/logo.png +0 -0
  60. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/src/mkdocstrings_handlers/github/__init__.py +0 -0
  61. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/src/mkdocstrings_handlers/github/py.typed +0 -0
  62. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/src/mkdocstrings_handlers/github/templates/material/action.html.jinja +0 -0
  63. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/src/mkdocstrings_handlers/github/templates/material/heading.html.jinja +0 -0
  64. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/src/mkdocstrings_handlers/github/templates/material/style.css +0 -0
  65. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/src/mkdocstrings_handlers/github/templates/material/workflow.html.jinja +0 -0
  66. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/__init__.py +0 -0
  67. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/conftest.py +0 -0
  68. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/docs/.gitkeep +0 -0
  69. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/helpers.py +0 -0
  70. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/.gitignore +0 -0
  71. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/0a37a4286738a72a224871dbd1bcd3c662e768f800a8e2b92c410d672c1d19fc.html +0 -0
  72. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/0c67cdd8572de4a97d061f099552f428affde9f418d962c119559531a92f57aa.html +0 -0
  73. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/1322d6390dbc167e4d2734b6ff7ac30265a52feb242ece864fd08dd36a88214a.html +0 -0
  74. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/1bb484ae2f4d2bfc6473c265761d6ba4f76c5be5dbd3a9059758e67589f4b320.html +0 -0
  75. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/22929d6c2b70b481583d7b07fd7bff72dba985a465d42ad4ee5a7f557429102f.html +0 -0
  76. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/2500c66e16468b20050dd9b8b152a48644d008c0316e444f47afc7bc5117e004.html +0 -0
  77. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/28df0ab9fe5662687b72cbb8b2c8e2e18b98beb5a114a505ad845c91b8955a2e.html +0 -0
  78. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/2eb63f18b2d0aaf8000ffcc081c80067937fc7cacea496c2871198aa3bc12a14.html +0 -0
  79. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/36d5597971381260ce0cd98b6ba1c3973134add32288bf34f47290fdbe55b0ec.html +0 -0
  80. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/37c546e4aceaf4af0a681bdaa444b8be901c78713e762fd96d2237b8a78811c5.html +0 -0
  81. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/3cb099624d882a4cde3ef6fdbea56c9aced9331dca1e19c7bc311c2611782e0d.html +0 -0
  82. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/50af1499553795c8cd859a1c9aa5ba162ef1c3dd9fa466668fc2da5bb002a61c.html +0 -0
  83. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/572198cee6d40e3c875970ee6b4c654b3edae54c5a00ee4792df2b0d5a161796.html +0 -0
  84. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/5a2f11e94bc00c7a5122364dcffcdc9bd5c514a773fbf4d1b04fa7e96ba2cfa5.html +0 -0
  85. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/5f0693318b13614e630f852af6ad9165a3793e2e011d4de786b84e178eb411bc.html +0 -0
  86. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/757b79d7975f29e7b7eeda8c910578cb858a867dc4c647c4b5bc9a4c45dbf62e.html +0 -0
  87. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/78f74a133e98bd757a1bd1c4667dc3a5d7cc40cc78daf596187999cb083ec6c4.html +0 -0
  88. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/78feb92e4171bf067dd1615523e5c9cac0de998bb7102ee70da2e145d1262339.html +0 -0
  89. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/856a4ff20ee15b09367d852d57cdb6a3376b799760365dbf7677c216156a7b4d.html +0 -0
  90. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/8df27f9a94e16efe5686ebeded8a93bd5b071f4d39fe47224ce218a6b1e58b90.html +0 -0
  91. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/93bf082d40ca4b6730a503aa4d265901a8cfed7ed1a6e9bb6e584c2c3ebd18af.html +0 -0
  92. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/98e4b6474a6f67576ae40a75e152e6bd8c3e743259ad7f1d08890def2ff858d1.html +0 -0
  93. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/98ed5c777c164326632ca657e3cb87ae3f9b75bf9793ab2db4ab90ee7874621c.html +0 -0
  94. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/ac47b3b933709154de762d06903d78925cea9f1ec93865386d669680cf17e4a8.html +0 -0
  95. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/b972a05ffc5672d471d5b1e84b01470a3363a25f9d9adbc8d82f4b9fd21a94a1.html +0 -0
  96. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/c2181f9e06dd6b7437f14e815c4fd32ec304e4474c93e86c02b43f41367a79ff.html +0 -0
  97. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/c50b7f91aafff5caf0fe0ff96a922b499617966705cde0d3622191f51f523b38.html +0 -0
  98. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/c8c895c400f0532aa3afe641f79ed14bc399b504169242c0a9f77572c185def2.html +0 -0
  99. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/cdad9a8909ec6448ff4392f523d4c7d41dcba61fc635e7e744026f901df04913.html +0 -0
  100. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/cdf58c1c57a805ff06487f8361728c09ddf37f7ef3235ad26effab9f1f07f5a4.html +0 -0
  101. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/d2e25cb02f371db9bd247a36766f7887ef1d2adad97ba1102ab1d98cf3128dc3.html +0 -0
  102. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/snapshots/external/f90542b4e3cbaf7e9820cdad6bbe707e3210983c911f11584cfae580e5cf6a04.html +0 -0
  103. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/test_handler.py +0 -0
  104. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/test_render_action.py +0 -0
  105. {mkdocstrings_github-0.1.0 → mkdocstrings_github-0.2.1}/test/test_render_workflow.py +0 -0
@@ -58,14 +58,21 @@ jobs:
58
58
  git config --global user.email 41898282+github-actions[bot]@users.noreply.github.com
59
59
 
60
60
  - name: Build documentation with mike
61
+ shell: bash
61
62
  env:
62
63
  PUSH_DEPLOY: ${{ fromJson(inputs.push) && '--push' || '' }}
63
- run: >
64
- uv run mike deploy ${PUSH_DEPLOY}
65
- --update-aliases
66
- --branch gh-pages
67
- --alias-type symlink
68
- ${{ inputs.version }} ${{ inputs.alias }}
64
+ GH_TOKEN: ${{ github.token }}
65
+ VERSION: ${{ inputs.version }}
66
+ run: |
67
+ if [[ $VERSION =~ ^v([0-9]+)\.([0-9]+)\.([0-9]+)$ ]]; then
68
+ VERSION="v${BASH_REMATCH[1]}.${BASH_REMATCH[2]}.*"
69
+ echo "Patching version "${{ inputs.version}}" to $VERSION"
70
+ fi
71
+ uv run mike deploy ${PUSH_DEPLOY} \
72
+ --update-aliases \
73
+ --branch gh-pages \
74
+ --alias-type symlink \
75
+ "$VERSION" "${{ inputs.alias }}"
69
76
 
70
77
  - name: Set default alias for mike
71
78
  if: ${{ fromJson(inputs.set-default) }}
@@ -14,7 +14,7 @@ on:
14
14
  type: string
15
15
  default: 'latest'
16
16
  enable-notifications:
17
- description: 'Whether to send notifications'
17
+ description: 'Whether to send notifications. Requires [`SLACK_WEBHOOK`](#secrets.SLACK_WEBHOOK) to be set.'
18
18
  required: false
19
19
  type: boolean
20
20
  default: false
@@ -109,7 +109,7 @@ jobs:
109
109
  env:
110
110
  GH_TOKEN: ${{ steps.app-token.outputs.token }}
111
111
  run: |
112
- uv run semantic-release -v version --commit --tag --push --changelog --vcs-release --skip-build
112
+ uv run semantic-release -v version --commit --tag --push --changelog --vcs-release
113
113
 
114
114
  deploy:
115
115
  name: Deploy package distributions
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: mkdocstrings-github
3
- Version: 0.1.0
3
+ Version: 0.2.1
4
4
  Summary: A GitHub Action handler for mkdocstrings
5
5
  Author-email: Mark Hu <watermarkhu@gmail.com>
6
6
  License: MIT
@@ -60,5 +60,6 @@ dependencies = [
60
60
  - ✨ **Enhanced Markdown Descriptions**: All description elements are parsed using a markdown parser, enabling comprehensive formatting and rich documentation capabilities.
61
61
  - 🧩 **Individual Parameter Hyperlinks**: Each action or workflow parameter—including inputs, outputs, and secrets—receives a unique HTML id, facilitating direct linking to specific parameter documentation.
62
62
  - 🔒 **Automated Permission Aggregation**: For reusable workflows, if permissions are specified at the job level rather than the workflow level, the required final permissions are automatically determined and displayed in the signature.
63
+ - 🔗 **Parameter cross-linking**: Link to other parameters of the action or workflow via a simple Markdown syntax.
63
64
 
64
65
  <!-- --8<-- [end:footer] -->
@@ -32,5 +32,6 @@ dependencies = [
32
32
  - ✨ **Enhanced Markdown Descriptions**: All description elements are parsed using a markdown parser, enabling comprehensive formatting and rich documentation capabilities.
33
33
  - 🧩 **Individual Parameter Hyperlinks**: Each action or workflow parameter—including inputs, outputs, and secrets—receives a unique HTML id, facilitating direct linking to specific parameter documentation.
34
34
  - 🔒 **Automated Permission Aggregation**: For reusable workflows, if permissions are specified at the job level rather than the workflow level, the required final permissions are automatically determined and displayed in the signature.
35
+ - 🔗 **Parameter cross-linking**: Link to other parameters of the action or workflow via a simple Markdown syntax.
35
36
 
36
37
  <!-- --8<-- [end:footer] -->
@@ -1,6 +1,6 @@
1
1
  # General options
2
2
 
3
- ??? tip "Example yaml files"
3
+ ??? info "Example action/workflow"
4
4
 
5
5
  ??? preview "compsite action `action.yaml`"
6
6
 
@@ -1,6 +1,6 @@
1
1
  # Headings options
2
2
 
3
- ??? tip "Example yaml files"
3
+ ??? info "Example action/workflow"
4
4
 
5
5
  ??? preview "compsite action `action.yaml`"
6
6
 
@@ -1,6 +1,6 @@
1
1
  # Usage
2
2
 
3
- !!! tip "Example yaml files"
3
+ !!! info "Example action/workflow"
4
4
 
5
5
  Throughout the next pages, we will use a composite action `action.yaml` and a reusable workflow `.github/workflows/example_workflow.yml` as examples.
6
6
 
@@ -18,7 +18,7 @@
18
18
 
19
19
  ## Installation
20
20
 
21
- This package is extension package to [*mkdocstrings*](https://mkdocstrings.github.io/), which is a framework for auto-documentation for various languanges, which can plugin into the framework by providing *handlers*. The *mkdocstrings-github* package provides a GitHub hanlder.
21
+ This package is extension package to [*mkdocstrings*](https://mkdocstrings.github.io/), a framework for auto-documentation for various languanges. Language support is inserted into the framework by providing *handlers*. The *mkdocstrings-github* package provides a GitHub hanlder.
22
22
 
23
23
  --8<-- "README.md:install"
24
24
 
@@ -80,6 +80,10 @@ For reusable workflows, which are workflows that include the [`workflow_call`](h
80
80
  ::: .github/workflows/myworkflow.yml
81
81
  ```
82
82
 
83
+ ## Linking
84
+
85
+ For every documented action or workflow, HTML tags are inserted on the page to allow linking with the action/workflow path as the id. Additionally, linking to action and workflow parameters, and cross-linking to other parameters, is possible with the [`parameters_anchors`][mkdocstrings_handlers.github.config.GitHubOptions.parameters_anchors] option.
86
+
83
87
  ## Configuration
84
88
 
85
89
  When installed, the Github handler can be configured in `mkdocs.yml`
@@ -131,3 +135,12 @@ These options affect how the documentation is collected from sources and rendere
131
135
  - [Headings options](./headings.md): options related to the headings and the table of contents.
132
136
  - [Signature options](./signatures.md): options related to the shown call signature.
133
137
  - [Parameters options](./parameters.md): options related to the input (and output) parameters of the action or workflow.
138
+
139
+
140
+ ::: mkdocstrings_handlers.github.config.GitHubOptions
141
+ handler: python
142
+ options:
143
+ show_bases: false
144
+ show_source: false
145
+ show_root_heading: false
146
+ members: false
@@ -1,6 +1,6 @@
1
1
  # Parameters options
2
2
 
3
- ??? tip "Example yaml files"
3
+ ??? info "Example action/workflow"
4
4
 
5
5
  ??? preview "compsite action `action.yaml`"
6
6
 
@@ -14,7 +14,6 @@
14
14
  --8<-- ".github/workflows/example_workflow.yml"
15
15
  ```
16
16
 
17
-
18
17
  ::: mkdocstrings_handlers.github.config.GitHubOptions.show_inputs
19
18
  handler: python
20
19
 
@@ -137,6 +136,13 @@
137
136
  ::: mkdocstrings_handlers.github.config.GitHubOptions.parameters_anchors
138
137
  handler: python
139
138
 
139
+
140
+ !!! tip "Cross linking parameters"
141
+
142
+ It is possible to cross-link parameters within the yaml descriptions by a markdown link in the format `[text](#<domain>.<name>)`.
143
+
144
+ E.g. the input `my_input` can be linked with `[text](#inputs.my_input)` the secret `MY_SECRET` is linked with `[text](#secrets.MY_SECRET)`.
145
+
140
146
  ??? preview
141
147
 
142
148
  === "`parameters_anchors: true`"
@@ -1,6 +1,6 @@
1
1
  # Signatures options
2
2
 
3
- ??? tip "Example yaml files"
3
+ ??? info "Example action/workflow"
4
4
 
5
5
  ??? preview "compsite action `action.yaml`"
6
6
 
@@ -69,6 +69,25 @@
69
69
  ::: mkdocstrings_handlers.github.config.GitHubOptions.signature_version
70
70
  handler: python
71
71
 
72
+ !!! info
73
+
74
+ To automatically grab the latest `major` or `semver` release, *mkdocstrings-github* needs to access GitHub to get the releases. Authentication is set by either the environment variable `GH_TOKEN`, or via [`.netrc`](https://pygithub.readthedocs.io/en/stable/examples/Authentication.html#netrc-authentication). If both aren't available, a final attempt is made via the GitHub CLI with [`gh auth token`](https://cli.github.com/manual/gh_auth_token).
75
+
76
+ When building your documentation in GitHub Actions, make sure that the build step has the environment variable `GH_TOKEN` set.
77
+
78
+ ```yaml title="Example build step"
79
+ ...
80
+ - name: build step
81
+ env:
82
+ GH_TOKEN: ${{ github.token }}
83
+ run: |
84
+ mkdocs build
85
+ ```
86
+
87
+ !!! info
88
+
89
+ For GitHub Enterprise instances, you need to additinally set the `GH_HOST` environment variable to your GitHub hostname.
90
+
72
91
  ??? preview
73
92
 
74
93
  === "`signature_version: ref`"
@@ -125,14 +125,16 @@ plugins:
125
125
  show_toc_entry: false
126
126
  heading_level: 3
127
127
  parameters_anchors: false
128
+ signature_version: string
129
+ signature_version_string: v1
128
130
  python:
129
131
  paths: [src]
130
132
  options:
133
+ show_attribute_values: false
131
134
  show_root_heading: true
132
135
  show_root_full_path: false
133
136
  show_root_toc_entry: false
134
137
  show_labels: false
135
- show_signature_annotations: true
136
138
  extensions:
137
139
  - griffe_pydantic:
138
140
  schema: true
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "mkdocstrings-github"
3
- version = "0.1.0"
3
+ version = "0.2.1"
4
4
  description = "A GitHub Action handler for mkdocstrings"
5
5
  authors = [
6
6
  { name = "Mark Hu", email = "watermarkhu@gmail.com" }
@@ -32,9 +32,6 @@ dependencies = [
32
32
  "typing-extensions>=4.0; python_version < '3.11'",
33
33
  ]
34
34
 
35
- [tool.uv.sources]
36
- pygments = { git = "https://github.com/watermarkhu/pygments", branch = "matlab" }
37
-
38
35
  [dependency-groups]
39
36
  dev = [
40
37
  "ty~=0.0.1a19",
@@ -102,6 +99,7 @@ allow-direct-references = true
102
99
  packages = ["src/mkdocstrings_handlers"]
103
100
 
104
101
  [tool.semantic_release]
102
+ build_command = "uv sync"
105
103
  commit_message = "{version}\n\nAutomatically generated by python-semantic-release"
106
104
  commit_parser = "conventional"
107
105
  logging_use_named_masks = false
@@ -25,7 +25,9 @@ PARAMETERS_SECTION_STYLE = Literal["table", "list"]
25
25
 
26
26
 
27
27
  class GitHubOptions(BaseModel):
28
- """Input options for the GitHub handler."""
28
+ """The following are the available options for the GitHub handler.
29
+ The options are loaded as a pydantic model, so they are type-checked and validated.
30
+ """
29
31
 
30
32
  # General options
31
33
  show_description: bool = Field(
@@ -102,12 +104,18 @@ class GitHubOptions(BaseModel):
102
104
 
103
105
  signature_version: SIGNATURE_VERSION = Field(
104
106
  default="ref",
105
- description="The versioning scheme to use for the signature.",
107
+ description="""The versioning scheme to use for the signature.
108
+
109
+ - `ref`: use the git ref (branch or tag) from which the workflow or action is run,
110
+ - `major`: use the latest release tag matching `vX` (e.g. `v1`, `v2`),
111
+ - `semver`: use the latest release tag matching `vX.X.X` (e.g. `v1.0.0`, `v2.1.3`),
112
+ - `string`: use the string provided in the [`signature_version_string`][mkdocstrings_handlers.github.config.GitHubOptions.signature_version_string] option.
113
+ """,
106
114
  )
107
115
 
108
116
  signature_version_string: str = Field(
109
117
  default="latest",
110
- description="The version string to use if `signature_version` is set to `string`.",
118
+ description="The version string to use if [`signature_version`][mkdocstrings_handlers.github.config.GitHubOptions.signature_version] is set to `string`.",
111
119
  )
112
120
 
113
121
  # Parameter options
@@ -4,6 +4,7 @@ from __future__ import annotations
4
4
 
5
5
  import os
6
6
  import re
7
+ import subprocess
7
8
  import sys
8
9
  from pathlib import Path
9
10
  from typing import TYPE_CHECKING, Any, ClassVar, Mapping
@@ -17,7 +18,7 @@ from mkdocstrings import (
17
18
  get_logger,
18
19
  )
19
20
 
20
- from github import Github
21
+ from github import Auth, Github
21
22
  from mkdocstrings_handlers.github import rendering
22
23
  from mkdocstrings_handlers.github.config import GitHubConfig, GitHubOptions
23
24
  from mkdocstrings_handlers.github.objects import Action, Workflow
@@ -78,7 +79,33 @@ class GitHubHandler(BaseHandler):
78
79
  rendering.ENV_MAJOR_TAG not in os.environ or rendering.ENV_SEMVER_TAG not in os.environ
79
80
  ) and "pytest" not in sys.modules:
80
81
  # Use PyGitHub to find last GitHub releases with tags matching vX.X.X and vX
81
- gh = Github()
82
+
83
+ GH_HOST = os.environ.get("GH_HOST", "https://github.com")
84
+ base_url = f"{GH_HOST}/api/v3"
85
+
86
+ if "GH_TOKEN" in os.environ or "GITHUB_TOKEN" in os.environ:
87
+ gh = Github(
88
+ base_url=base_url,
89
+ auth=Auth.Token(os.environ.get("GH_TOKEN", os.environ["GITHUB_TOKEN"])),
90
+ )
91
+ else:
92
+ try:
93
+ gh = Github(base_url=base_url, auth=Auth.NetrcAuth())
94
+ except RuntimeError:
95
+ try:
96
+ token = subprocess.check_output(["gh", "auth", "token"], text=True).strip()
97
+ if token:
98
+ gh = Github(auth=Auth.Token(token))
99
+ else:
100
+ raise RuntimeError("No token from gh auth token")
101
+ except Exception:
102
+ _logger.warning(
103
+ "Could not authenticate with GitHub to get releases. "
104
+ "Consider setting .netrc, environment variable GITHUB_TOKEN, "
105
+ "or using GitHub CLI (`gh auth login`) to get GitHub releases.",
106
+ )
107
+ gh = Github()
108
+
82
109
  owner, repo_name = self.config.repo.split("/", 1)
83
110
  gh_repo = gh.get_repo(f"{owner}/{repo_name}")
84
111
  releases = list(gh_repo.get_releases())
@@ -90,12 +117,21 @@ class GitHubHandler(BaseHandler):
90
117
  self.major = tag
91
118
  if self.semver and self.major:
92
119
  break
93
- else:
120
+
121
+ if not self.semver or not self.major:
122
+ if not self.semver and not self.major:
123
+ messages = ("'vX.X.X' and 'vX'", "'semver and major'")
124
+ elif not self.semver:
125
+ messages = ("'vX.X.X'", "'semver'")
126
+ else: # not self.major
127
+ messages = ("'vX'", "'major'")
94
128
  _logger.warning(
95
129
  "Could not find suitable GitHub releases for repo '%s'. "
96
- "Make sure there are releases with tags matching 'vX.X.X' and 'vX', "
97
- "if you wish to use the 'semver' and 'major' signature versions.",
130
+ "Make sure there are releases with tags matching %s, "
131
+ "if you wish to use option signature_version %s.",
98
132
  self.config.repo,
133
+ messages[0],
134
+ messages[1],
99
135
  )
100
136
 
101
137
  if self.config.repo == ".":
@@ -159,6 +195,7 @@ class GitHubHandler(BaseHandler):
159
195
  self.env.filters["format_action_signature"] = rendering.format_action_signature
160
196
  self.env.filters["order_parameters"] = rendering.order_parameters
161
197
  self.env.filters["filter_parameters"] = rendering.filter_parameters
198
+ self.env.filters["anchor_id"] = rendering.anchor_id
162
199
  self.env.globals["semver_tag"] = self.semver
163
200
  self.env.globals["major_tag"] = self.major
164
201
  self.env.globals["git_repo"] = self.repo
@@ -106,6 +106,10 @@ class Action:
106
106
  branding: dict = field(default_factory=dict)
107
107
  template: Literal["action.html.jinja"] = "action.html.jinja"
108
108
 
109
+ @property
110
+ def members(self) -> list[Input | Output]:
111
+ return self.inputs + self.outputs
112
+
109
113
  @staticmethod
110
114
  def from_file(file: PathLike, id: str) -> "Action":
111
115
  source, data = _read_file(file)
@@ -182,6 +186,10 @@ class Workflow:
182
186
  outputs: list[Output] = field(default_factory=list)
183
187
  template: Literal["workflow.html.jinja"] = "workflow.html.jinja"
184
188
 
189
+ @property
190
+ def members(self) -> list[Input | Output | Secret]:
191
+ return self.inputs + self.outputs + self.secrets
192
+
185
193
  @staticmethod
186
194
  def from_file(file: PathLike, id: str) -> "Workflow | None":
187
195
  source, data = _read_file(file)
@@ -67,3 +67,8 @@ def filter_parameters(
67
67
  if not filter:
68
68
  filtered.append(parameter)
69
69
  return filtered
70
+
71
+
72
+ def anchor_id(name: str, prefix: str, parent_id: str) -> str:
73
+ anchor = f"{parent_id}--{prefix}.{name}"
74
+ return anchor.replace(" ", "-")
@@ -32,9 +32,7 @@ Context:
32
32
  <tbody>
33
33
  {% for input in inputs %}
34
34
  {% if options.parameters_anchors %}
35
- {% set anchor_id -%}
36
- input-{{ data.id | replace('/', '-') | replace('.', '') | lower }}-{{ input.name | replace(' ', '-') | lower }}
37
- {%- endset %}
35
+ {% set anchor_id = input.name | anchor_id("inputs", data.id) %}
38
36
  {% else %}
39
37
  {% set anchor_id = None %}
40
38
  {% endif %}
@@ -70,9 +68,7 @@ Context:
70
68
  </p>
71
69
  <ul>
72
70
  {% for input in inputs %}
73
- {% set anchor_id -%}
74
- input-{{ data.id | replace('/', '-') | replace('.', '') | lower }}-{{ input.name | replace(' ', '-') | lower }}
75
- {%- endset %}
71
+ {% set anchor_id = input.name | anchor_id("inputs", data.id) %}
76
72
  <li class="doc-section-item field-body">
77
73
  <b><code>{{ input.name }}</code></b>
78
74
  {%- if input.required %} - <em>required</em>{% endif %}
@@ -80,7 +76,7 @@ Context:
80
76
  <a class="headerlink" href="#{{ anchor_id }}" title="Link to {{ input.name }}">¤</a>
81
77
  {% endif %}
82
78
  <div class="doc-md-description">
83
- {{ input.description|convert_markdown(options.heading_level, data.id) }}
79
+ {{ input.description | convert_markdown(options.heading_level, data.id) }}
84
80
  </div>
85
81
  {% if input.default is not none %}
86
82
  <div class="doc-md-description">
@@ -31,9 +31,7 @@ Context:
31
31
  <tbody>
32
32
  {% for output in outputs %}
33
33
  {% if options.parameters_anchors %}
34
- {% set anchor_id -%}
35
- output-{{ data.id | replace('/', '-') | replace('.', '') | lower }}-{{ output.name | replace(' ', '-') | lower }}
36
- {%- endset %}
34
+ {% set anchor_id = output.name | anchor_id("outputs", data.id) %}
37
35
  {% else %}
38
36
  {% set anchor_id = None %}
39
37
  {% endif %}
@@ -59,16 +57,14 @@ Context:
59
57
  </p>
60
58
  <ul>
61
59
  {% for output in outputs %}
62
- {% set anchor_id -%}
63
- output-{{ data.id | replace('/', '-') | replace('.', '') | lower }}-{{ output.name | replace(' ', '-') | lower }}
64
- {%- endset %}
60
+ {% set anchor_id = output.name | anchor_id("outputs", data.id) %}
65
61
  <li class="doc-section-item field-body">
66
62
  <b><code>{{ output.name }}</code></b>
67
63
  {% if options.parameters_anchors %}
68
64
  <a class="headerlink" href="#{{ anchor_id }}" title="Link to {{ output.name }}">¤</a>
69
65
  {% endif %}
70
66
  <div class="doc-md-description">
71
- {{ output.description|convert_markdown(options.heading_level, data.id) }}
67
+ {{ output.description | convert_markdown(options.heading_level, data.id) }}
72
68
  </div>
73
69
  </li>
74
70
  {% endfor %}
@@ -31,9 +31,7 @@ Context:
31
31
  <tbody>
32
32
  {% for secret in secrets %}
33
33
  {% if options.parameters_anchors %}
34
- {% set anchor_id -%}
35
- secret-{{ data.id | replace('/', '-') | replace('.', '') | lower }}-{{ secret.name | replace(' ', '-') | lower }}
36
- {%- endset %}
34
+ {% set anchor_id = secret.name | anchor_id("secrets", data.id) %}
37
35
  {% else %}
38
36
  {% set anchor_id = None %}
39
37
  {% endif %}
@@ -63,9 +61,7 @@ Context:
63
61
  </p>
64
62
  <ul>
65
63
  {% for secret in secrets %}
66
- {% set anchor_id -%}
67
- secret-{{ data.id | replace('/', '-') | replace('.', '') | lower }}-{{ secret.name | replace(' ', '-') | lower }}
68
- {%- endset %}
64
+ {% set anchor_id = secret.name | anchor_id("secrets", data.id) %}
69
65
  <li class="doc-section-item field-body">
70
66
  <b><code>{{ secret.name }}</code></b>
71
67
  {%- if secret.required %} - <em>required</em>{% endif %}
@@ -73,7 +69,7 @@ Context:
73
69
  <a class="headerlink" href="#{{ anchor_id }}" title="Link to {{ secret.name }}">¤</a>
74
70
  {% endif %}
75
71
  <div class="doc-md-description">
76
- {{ secret.description|convert_markdown(options.heading_level, data.id) }}
72
+ {{ secret.description | convert_markdown(options.heading_level, data.id) }}
77
73
  </div>
78
74
  </li>
79
75
  {% endfor %}
@@ -71,7 +71,7 @@ workflow_show = snapshot(
71
71
  ("show_secrets", True),
72
72
  ("parameters_order", "alphabetical"),
73
73
  ("parameters_section_style", "table"),
74
- ): external("hash:cb58c01daaeb*.html"),
74
+ ): external("hash:a5c25b6859cc*.html"),
75
75
  (
76
76
  ("show_inputs", True),
77
77
  ("show_inputs_only_required", True),
@@ -79,7 +79,7 @@ workflow_show = snapshot(
79
79
  ("show_secrets", False),
80
80
  ("parameters_order", "alphabetical"),
81
81
  ("parameters_section_style", "table"),
82
- ): external("hash:8648f88cc212*.html"),
82
+ ): external("hash:b3235de10ed4*.html"),
83
83
  (
84
84
  ("show_inputs", False),
85
85
  ("show_inputs_only_required", False),
@@ -95,7 +95,7 @@ workflow_show = snapshot(
95
95
  ("show_secrets", True),
96
96
  ("parameters_order", "source"),
97
97
  ("parameters_section_style", "table"),
98
- ): external("hash:c00418e99257*.html"),
98
+ ): external("hash:c8601796046e*.html"),
99
99
  (
100
100
  ("show_inputs", True),
101
101
  ("show_inputs_only_required", True),
@@ -103,7 +103,7 @@ workflow_show = snapshot(
103
103
  ("show_secrets", False),
104
104
  ("parameters_order", "source"),
105
105
  ("parameters_section_style", "table"),
106
- ): external("hash:3f50016a2686*.html"),
106
+ ): external("hash:fab6f055074f*.html"),
107
107
  (
108
108
  ("show_inputs", False),
109
109
  ("show_inputs_only_required", False),
@@ -119,7 +119,7 @@ workflow_show = snapshot(
119
119
  ("show_secrets", True),
120
120
  ("parameters_order", "alphabetical"),
121
121
  ("parameters_section_style", "list"),
122
- ): external("hash:4b4fbfc27652*.html"),
122
+ ): external("hash:e5a8b4ccf809*.html"),
123
123
  (
124
124
  ("show_inputs", True),
125
125
  ("show_inputs_only_required", True),
@@ -127,7 +127,7 @@ workflow_show = snapshot(
127
127
  ("show_secrets", False),
128
128
  ("parameters_order", "alphabetical"),
129
129
  ("parameters_section_style", "list"),
130
- ): external("hash:92bd52ad97f5*.html"),
130
+ ): external("hash:d0d656ae3243*.html"),
131
131
  (
132
132
  ("show_inputs", False),
133
133
  ("show_inputs_only_required", False),
@@ -143,7 +143,7 @@ workflow_show = snapshot(
143
143
  ("show_secrets", True),
144
144
  ("parameters_order", "source"),
145
145
  ("parameters_section_style", "list"),
146
- ): external("hash:7d6a6f97b26c*.html"),
146
+ ): external("hash:62440ee595f9*.html"),
147
147
  (
148
148
  ("show_inputs", True),
149
149
  ("show_inputs_only_required", True),
@@ -151,7 +151,7 @@ workflow_show = snapshot(
151
151
  ("show_secrets", False),
152
152
  ("parameters_order", "source"),
153
153
  ("parameters_section_style", "list"),
154
- ): external("hash:af4931df88d0*.html"),
154
+ ): external("hash:bbea0ecf08ae*.html"),
155
155
  (
156
156
  ("show_inputs", False),
157
157
  ("show_inputs_only_required", False),
@@ -202,14 +202,14 @@ action_show = snapshot(
202
202
  ("show_outputs", True),
203
203
  ("parameters_order", "alphabetical"),
204
204
  ("parameters_section_style", "table"),
205
- ): external("hash:25090fe68096*.html"),
205
+ ): external("hash:f575eacc0b72*.html"),
206
206
  (
207
207
  ("show_inputs", True),
208
208
  ("show_inputs_only_required", True),
209
209
  ("show_outputs", False),
210
210
  ("parameters_order", "alphabetical"),
211
211
  ("parameters_section_style", "table"),
212
- ): external("hash:ce8c324c6d38*.html"),
212
+ ): external("hash:27b0437dc257*.html"),
213
213
  (
214
214
  ("show_inputs", False),
215
215
  ("show_inputs_only_required", False),
@@ -223,14 +223,14 @@ action_show = snapshot(
223
223
  ("show_outputs", True),
224
224
  ("parameters_order", "source"),
225
225
  ("parameters_section_style", "table"),
226
- ): external("hash:9536cc7cfc76*.html"),
226
+ ): external("hash:293f8ca97697*.html"),
227
227
  (
228
228
  ("show_inputs", True),
229
229
  ("show_inputs_only_required", True),
230
230
  ("show_outputs", False),
231
231
  ("parameters_order", "source"),
232
232
  ("parameters_section_style", "table"),
233
- ): external("hash:314a0e4ec397*.html"),
233
+ ): external("hash:84f918940f7b*.html"),
234
234
  (
235
235
  ("show_inputs", False),
236
236
  ("show_inputs_only_required", False),
@@ -244,14 +244,14 @@ action_show = snapshot(
244
244
  ("show_outputs", True),
245
245
  ("parameters_order", "alphabetical"),
246
246
  ("parameters_section_style", "list"),
247
- ): external("hash:5a31bebe73cd*.html"),
247
+ ): external("hash:24dfcb59a486*.html"),
248
248
  (
249
249
  ("show_inputs", True),
250
250
  ("show_inputs_only_required", True),
251
251
  ("show_outputs", False),
252
252
  ("parameters_order", "alphabetical"),
253
253
  ("parameters_section_style", "list"),
254
- ): external("hash:73064e20f309*.html"),
254
+ ): external("hash:f0d6c0adbfcc*.html"),
255
255
  (
256
256
  ("show_inputs", False),
257
257
  ("show_inputs_only_required", False),
@@ -265,14 +265,14 @@ action_show = snapshot(
265
265
  ("show_outputs", True),
266
266
  ("parameters_order", "source"),
267
267
  ("parameters_section_style", "list"),
268
- ): external("hash:99ee5da4993d*.html"),
268
+ ): external("hash:0ef4f0725daf*.html"),
269
269
  (
270
270
  ("show_inputs", True),
271
271
  ("show_inputs_only_required", True),
272
272
  ("show_outputs", False),
273
273
  ("parameters_order", "source"),
274
274
  ("parameters_section_style", "list"),
275
- ): external("hash:0cb5db6b0e9e*.html"),
275
+ ): external("hash:dbb6b804e35c*.html"),
276
276
  (
277
277
  ("show_inputs", False),
278
278
  ("show_inputs_only_required", False),