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.8.0.tar.gz
(863.1 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.8.0.tar.gz.
File metadata
- Download URL: mkdocstrings_github-0.8.0.tar.gz
- Upload date:
- Size: 863.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","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 |
7baac9d978d81d9f945fe9ebb92fa189e7b8b8908cb50cdc0f8a433e959f9c75
|
|
| MD5 |
953e25ddef2a61c174599a04d00549bb
|
|
| BLAKE2b-256 |
c4cb5b349a06499e6c342c3a76275d8f5498193516239a2dbd69675ff23789eb
|
File details
Details for the file mkdocstrings_github-0.8.0-py3-none-any.whl.
File metadata
- Download URL: mkdocstrings_github-0.8.0-py3-none-any.whl
- Upload date:
- Size: 23.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","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 |
b5708601377438fbffcf14fdae1c5a462b0492e95f670f5381befc38963aed87
|
|
| MD5 |
db72e5a1cfbbdcfb106c44ecbc866e62
|
|
| BLAKE2b-256 |
77f33267ec493aa7df7d251bfa9a9feb68db06856f721826f53cbdb50184a028
|
