[](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)
# 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.
## 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 2024 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.9",
"maintainer_email": null,
"keywords": "sphinx, invoke, plugin, inv, documentation",
"author": null,
"author_email": "Kai Mueller <kai.mueller01@sap.com>",
"download_url": "https://files.pythonhosted.org/packages/63/f6/2cd3366dbbb1da55315eee314128f8d07388bab648191d96686eafd55639/invoke_plugin_for_sphinx-3.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\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## 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 2024 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": "Apache-2.0",
"summary": "Sphinx plugin which can render invoke tasks with autodoc",
"version": "3.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": "",
"digests": {
"blake2b_256": "9786e31c89592fd126bca959bcee7c6669be927deacbed2f1b0327fd5bb51e4f",
"md5": "b476fad9063540e25cdb134d57f85d0e",
"sha256": "10b682f79170b246f20b4b3b9555480fc98c30010491b60d18b96a39c16186a8"
},
"downloads": -1,
"filename": "invoke_plugin_for_sphinx-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b476fad9063540e25cdb134d57f85d0e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 8234,
"upload_time": "2024-10-09T05:25:33",
"upload_time_iso_8601": "2024-10-09T05:25:33.217715Z",
"url": "https://files.pythonhosted.org/packages/97/86/e31c89592fd126bca959bcee7c6669be927deacbed2f1b0327fd5bb51e4f/invoke_plugin_for_sphinx-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "63f62cd3366dbbb1da55315eee314128f8d07388bab648191d96686eafd55639",
"md5": "6ab022fc9436a20b5da1191dc1413266",
"sha256": "ce6e7af826ad24ec1e6a88dcf604f3220b1b72a58bde474295fe3b9d73a84e00"
},
"downloads": -1,
"filename": "invoke_plugin_for_sphinx-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "6ab022fc9436a20b5da1191dc1413266",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 8570,
"upload_time": "2024-10-09T05:25:34",
"upload_time_iso_8601": "2024-10-09T05:25:34.735135Z",
"url": "https://files.pythonhosted.org/packages/63/f6/2cd3366dbbb1da55315eee314128f8d07388bab648191d96686eafd55639/invoke_plugin_for_sphinx-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-09 05:25:34",
"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
