diff --git a/docs/plugins.rst b/docs/plugins.rst index 952af3fd..c8d3e5ae 100644 --- a/docs/plugins.rst +++ b/docs/plugins.rst @@ -61,9 +61,10 @@ similar to ``pytest`` packages such as ``pytest-cov`` (the package) and .. note:: - We strongly recommend plugin authors name their plugins with the prefix + We recommend plugin authors name their plugins with the prefix ``ocrmypdf-`` (for the package name on PyPI) and ``ocrmypdf_`` (for the - module), just like pytest plugins. + module), just like pytest plugins. At the same time, please make it clear + that your package is not official. Setuptools plugins ================== @@ -86,6 +87,13 @@ named ``ocrmypdf-exampleplugin``: entry_points={"ocrmypdf": ["exampleplugin = exampleplugin.pluginmodule"]}, ) +.. code-block:: ini + + # equivalent setup.cfg + [options.entry_points] + ocrmypdf = + exampleplugin = exampleplugin.pluginmodule + Plugin requirements ===================