[](https://api.reuse.software/info/github.com/SAP/invoke-plugin-for-sphinx)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
[](https://badge.fury.io/py/invoke-plugin-for-sphinx)
[](https://coveralls.io/github/SAP/invoke-plugin-for-sphinx)
# Invoke Plugin for Sphinx
This is a plugin which allows the documentation of invoke tasks with sphinx `autodoc`.
An invoke task looks like a normal function but the `@task` decorator creates a `Task` object behind the scenes.
Documenting these with `autodoc` can lead to errors or unexpected results.
## Installation
`pip install invoke-plugin-for-sphinx`, that's it.
## Usage
Add the plugin to the extensions list:
```py
extensions = ["invoke_plugin_for_sphinx"]
```
Then you can use `.. automodule::` as usual.
Behind the scenes, the function documenter of `autodoc` is extended to also handle tasks equal to functions.
Therefore the same configurations, limitations and features apply.
## Development
This project uses `uv`.
To setup a venv for development use
`python3.14 -m venv venv && pip install uv && uv sync --all-groups && rm -rf venv/`.
Then use `source .venv/bin/activate` to activate your venv.
## Build and Publish
This project uses `setuptools` as the dependency management and build tool.
To publish a new release, follow these steps:
* Update the version in the `pyproject.toml`
* Add an entry in the changelog
* Push a new tag like `vX.X.X` to trigger the release
## Support, Feedback, Contributing
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/invoke-plugin-for-sphinx/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
## Code of Conduct
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md) at all times.
## Licensing
Copyright 2025 SAP SE or an SAP affiliate company and invoke-plugin-for-sphinx contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/invoke-plugin-for-sphinx).
Raw data
{
"_id": null,
"home_page": null,
"name": "invoke-plugin-for-sphinx",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.10",
"maintainer_email": null,
"keywords": "sphinx, invoke, plugin, inv, documentation",
"author": null,
"author_email": "Kai Harder <kai.harder@sap.com>",
"download_url": "https://files.pythonhosted.org/packages/dd/cd/d5ac03adcfb7ae2912410beb1638c336aa54df4d36fc31e8de2d16d300c9/invoke_plugin_for_sphinx-4.0.0.tar.gz",
"platform": null,
"description": "[](https://api.reuse.software/info/github.com/SAP/invoke-plugin-for-sphinx)\n[](https://github.com/psf/black)\n[](https://pycqa.github.io/isort/)\n[](https://badge.fury.io/py/invoke-plugin-for-sphinx)\n[](https://coveralls.io/github/SAP/invoke-plugin-for-sphinx)\n\n# Invoke Plugin for Sphinx\nThis is a plugin which allows the documentation of invoke tasks with sphinx `autodoc`.\nAn invoke task looks like a normal function but the `@task` decorator creates a `Task` object behind the scenes.\nDocumenting these with `autodoc` can lead to errors or unexpected results.\n\n## Installation\n`pip install invoke-plugin-for-sphinx`, that's it.\n\n## Usage\nAdd the plugin to the extensions list:\n\n```py\nextensions = [\"invoke_plugin_for_sphinx\"]\n```\n\nThen you can use `.. automodule::` as usual.\nBehind the scenes, the function documenter of `autodoc` is extended to also handle tasks equal to functions.\nTherefore the same configurations, limitations and features apply.\n\n## Development\nThis project uses `uv`.\nTo setup a venv for development use\n`python3.14 -m venv venv && pip install uv && uv sync --all-groups && rm -rf venv/`.\nThen use `source .venv/bin/activate` to activate your venv.\n\n## Build and Publish\n\nThis project uses `setuptools` as the dependency management and build tool.\nTo publish a new release, follow these steps:\n* Update the version in the `pyproject.toml`\n* Add an entry in the changelog\n* Push a new tag like `vX.X.X` to trigger the release\n\n## Support, Feedback, Contributing\n\nThis project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/invoke-plugin-for-sphinx/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).\n\n## Code of Conduct\n\nWe as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md) at all times.\n\n## Licensing\n\nCopyright 2025 SAP SE or an SAP affiliate company and invoke-plugin-for-sphinx contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/invoke-plugin-for-sphinx).\n",
"bugtrack_url": null,
"license": null,
"summary": "Sphinx plugin which can render invoke tasks with autodoc",
"version": "4.0.0",
"project_urls": {
"Changelog": "https://github.com/SAP/invoke-plugin-for-sphinx/blob/main/CHANGELOG.md",
"Issue Tracker": "https://github.com/SAP/invoke-plugin-for-sphinx/issues"
},
"split_keywords": [
"sphinx",
" invoke",
" plugin",
" inv",
" documentation"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d73256b51e10e99efe1ecbab7a47e84133e49d296351d96f5e9f446e6171828d",
"md5": "7c026d38200a28df8fd627b06d10307d",
"sha256": "d5f452aa2592db1b9442a07d47d3223226f2e5f07f7425e5b9b452204c659786"
},
"downloads": -1,
"filename": "invoke_plugin_for_sphinx-4.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7c026d38200a28df8fd627b06d10307d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.10",
"size": 8226,
"upload_time": "2025-10-16T06:39:58",
"upload_time_iso_8601": "2025-10-16T06:39:58.749392Z",
"url": "https://files.pythonhosted.org/packages/d7/32/56b51e10e99efe1ecbab7a47e84133e49d296351d96f5e9f446e6171828d/invoke_plugin_for_sphinx-4.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ddcdd5ac03adcfb7ae2912410beb1638c336aa54df4d36fc31e8de2d16d300c9",
"md5": "de9fae668a99fac57d4fd53be925c754",
"sha256": "442f679202e069f6c302c08b98ec119d21daf12a6ed20296219d77fd7de1b352"
},
"downloads": -1,
"filename": "invoke_plugin_for_sphinx-4.0.0.tar.gz",
"has_sig": false,
"md5_digest": "de9fae668a99fac57d4fd53be925c754",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.10",
"size": 9022,
"upload_time": "2025-10-16T06:39:59",
"upload_time_iso_8601": "2025-10-16T06:39:59.840115Z",
"url": "https://files.pythonhosted.org/packages/dd/cd/d5ac03adcfb7ae2912410beb1638c336aa54df4d36fc31e8de2d16d300c9/invoke_plugin_for_sphinx-4.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-16 06:39:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SAP",
"github_project": "invoke-plugin-for-sphinx",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "invoke-plugin-for-sphinx"
}
JSON
