mkdocstrings-github
A GitHub Actions handler for mkdocstrings.
For example, the following page is generated from actions/checkout:
You can install the GitHub handler by specifying it as a dependency:
# PEP 621 dependencies declaration
# adapt to your dependencies manager
[project]
dependencies = [
"mkdocstrings-github",
]
after which the generated documentation can be inserted in the markdown page with:
::: <path-to-action-or-workflow>
handler: github
Features
- 📝 Automatic Example Signature: Displays an example call signature alongside the description. The version shown can be the latest release, latest major, current reference, or any custom string.
- ✨ Enhanced Markdown Descriptions: All description elements are parsed using a markdown parser, enabling comprehensive formatting and rich documentation capabilities.
- 🧩 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.
- 🔒 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.
- 🔗 Parameter cross-linking: Link to other parameters of the action or workflow via a simple Markdown syntax.
- 🧑🤝🧑 Parameter grouping: Organize related inputs, outputs, and secrets into visual groups using inline YAML comments for clearer documentation structure.
Metadata
Release files for mkdocstrings-github 0.9.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocstrings_github-0.9.0.tar.gz | 864.7 kB | Without provenance | Details for mkdocstrings_github-0.9.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocstrings_github-0.9.0-py3-none-any.whl | Python 3 | none | any | Details for mkdocstrings_github-0.9.0-py3-none-any.whl |
Total release size: 888.6 kB
Release files / mkdocstrings_github-0.9.0.tar.gz
| Download URL | mkdocstrings_github-0.9.0.tar.gz |
|---|---|
| Size | 864.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dd408a35d2fcbb36659c8bc4008549ad056996830494fc049247db1c09062773
|
|
BLAKE2b-256 checksum How to use checksums |
52d11258023bc37a723443fd87284ef96c3c65c01156750441e513824eac87ed
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / mkdocstrings_github-0.9.0-py3-none-any.whl
| Download URL | mkdocstrings_github-0.9.0-py3-none-any.whl |
|---|---|
| Size | 23.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a70a7c723b4fbb2a6f755778e97da9a1624d8141b665af427a6a5cecfa88ac21
|
|
BLAKE2b-256 checksum How to use checksums |
a2663a6e8a7ac397c9123b1e8743ea75ad29e251b8b50f70086154e3d22b09ad
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for mkdocstrings-github 0.9.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.