details: https://code.tryton.org/hatch-tryton/commit/4af52c54d151
branch: default
user: Cédric Krier <[email protected]>
date: Fri Mar 13 12:04:19 2026 +0100
description:
Improve description in readme
diffstat:
README.rst | 34 ++++++++++++++++++++++++++--------
1 files changed, 26 insertions(+), 8 deletions(-)
diffs (45 lines):
diff -r b896a2beb4fd -r 4af52c54d151 README.rst
--- a/README.rst Fri Mar 13 07:56:29 2026 +0100
+++ b/README.rst Fri Mar 13 12:04:19 2026 +0100
@@ -28,15 +28,33 @@
.. code:: toml
[tool.hatch.metadata.hooks.tryton]
- config = 'tryton.cfg' # the relative path to the ``tryton.cfg``
- prefixes = {} # a mapping between module name and package prefix
- dependencies = [] # the list of dependencies that are not Tryton modules
- tryton_dependencies = [] # the list of dependencies that are Tryton
modules but not defined in ``tryton.cfg``
- readme = '' # the relative path to the readme file
- copyright = '' # the relative path to the copyright file
+ # Path to the ``tryton.cfg`` file
+ config = 'tryton.cfg'
+
+ # Dictionary mapping module names to their package prefixes
+ prefixes = {}
+
+ # List of dependencies that are not Tryton modules
+ dependencies = []
+
+ # List of dependencies that are specifically Tryton modules
+ tryton_dependencies = []
+
+ # Path to the README file
+ readme = ''
+
+ # Path to the copyright file
+ copyright = ''
[tool.hatch.metadata.hooks.tryton.optional-dependencies]
- # The optional dependencies that are not Tryton modules
+ # Add any optional non-Tryton dependencies here
[tool.hatch.metadata.hooks.tryton.tryton-optional-dependencies]
- # The optional dependencies that are Tryton modules but not defined in
``tryton.cfg`` as ``extras_depend`` as ``test`` option.
+ # Add any optional Tryton dependencies here
+
+.. note::
+
+ The ``depends`` in ``tryton.cfg`` are added automatically as dependencies.
+
+ The ``extras_depend`` in ``tryton.cfg`` are added automatically as ``test``
+ option dependencies.
