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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mkdocstrings_github-0.9.0.tar.gz
(864.7 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkdocstrings_github-0.9.0.tar.gz.
File metadata
- Download URL: mkdocstrings_github-0.9.0.tar.gz
- Upload date:
- Size: 864.7 kB
- Tags: Source
- Uploaded using 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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dd408a35d2fcbb36659c8bc4008549ad056996830494fc049247db1c09062773
|
|
| MD5 |
34ce0f6d9778ed0f29de52954a6d1516
|
|
| BLAKE2b-256 |
52d11258023bc37a723443fd87284ef96c3c65c01156750441e513824eac87ed
|
File details
Details for the file mkdocstrings_github-0.9.0-py3-none-any.whl.
File metadata
- Download URL: mkdocstrings_github-0.9.0-py3-none-any.whl
- Upload date:
- Size: 23.9 kB
- Tags: Python 3
- Uploaded using 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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a70a7c723b4fbb2a6f755778e97da9a1624d8141b665af427a6a5cecfa88ac21
|
|
| MD5 |
4c74140459ced45fd10656e56a11bbe2
|
|
| BLAKE2b-256 |
a2663a6e8a7ac397c9123b1e8743ea75ad29e251b8b50f70086154e3d22b09ad
|
