weblate/docs/contributing/addons.rst
Michal Čihař 8ffbef54ba add-ons: add type hints
- add type hints to base add-on class
- remove some possibilities of passing None
- better validation error when installing invalid add-on
2024-03-07 21:32:54 +01:00

42 lines
651 B
ReStructuredText

Developing add-ons
==================
:ref:`addons` are way to customize localization workflow in Weblate.
.. currentmodule:: weblate.addons.base
.. autoclass:: BaseAddon
:members:
.. class:: Addon
ORM object for an add-on.
.. class:: Component
ORM object for a component.
.. class:: Translation
ORM object for a translation.
.. class:: Project
ORM object for a project.
.. class:: Unit
ORM object for an unit.
.. class:: User
ORM object for an user.
.. class:: TranslationFormat
Translation file wrapper.
Here is an example add-on:
.. literalinclude:: ../../weblate/addons/example.py
:language: python