{"id":15097694,"url":"https://github.com/sap/invoke-plugin-for-sphinx","last_synced_at":"2025-10-19T05:29:29.334Z","repository":{"id":152368400,"uuid":"614273436","full_name":"SAP/invoke-plugin-for-sphinx","owner":"SAP","description":"A plugin for Sphinx which let's you document invoke tasks.","archived":false,"fork":false,"pushed_at":"2025-08-12T09:44:57.000Z","size":211,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-17T14:50:29.962Z","etag":null,"topics":["documentation","invoke","python","sphinx","sphinx-extension","task"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SAP.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-03-15T08:57:23.000Z","updated_at":"2025-08-12T09:44:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"b5c9bf0a-4255-4cc4-842d-bc153dcabdc6","html_url":"https://github.com/SAP/invoke-plugin-for-sphinx","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":"SAP/repository-template","purl":"pkg:github/SAP/invoke-plugin-for-sphinx","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP%2Finvoke-plugin-for-sphinx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP%2Finvoke-plugin-for-sphinx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP%2Finvoke-plugin-for-sphinx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP%2Finvoke-plugin-for-sphinx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SAP","download_url":"https://codeload.github.com/SAP/invoke-plugin-for-sphinx/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP%2Finvoke-plugin-for-sphinx/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272227798,"owners_count":24895685,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-26T02:00:07.904Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","invoke","python","sphinx","sphinx-extension","task"],"created_at":"2024-09-25T16:24:57.581Z","updated_at":"2025-10-19T05:29:29.314Z","avatar_url":"https://github.com/SAP.png","language":"Python","readme":"[![REUSE status](https://api.reuse.software/badge/github.com/SAP/invoke-plugin-for-sphinx)](https://api.reuse.software/info/github.com/SAP/invoke-plugin-for-sphinx)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat\u0026labelColor=ef8336)](https://pycqa.github.io/isort/)\n[![PyPI version](https://badge.fury.io/py/invoke-plugin-for-sphinx.svg)](https://badge.fury.io/py/invoke-plugin-for-sphinx)\n[![Coverage Status](https://coveralls.io/repos/github/SAP/invoke-plugin-for-sphinx/badge.svg)](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 \u0026\u0026 pip install uv \u0026\u0026 uv sync --all-groups \u0026\u0026 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","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsap%2Finvoke-plugin-for-sphinx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsap%2Finvoke-plugin-for-sphinx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsap%2Finvoke-plugin-for-sphinx/lists"}