invoke-plugin-for-sphinx 3.0.0

Sphinx plugin which can render invoke tasks with autodoc

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:

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. 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.

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 at all times.

Licensing

Copyright 2024 SAP SE or an SAP affiliate company and invoke-plugin-for-sphinx contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.