aboutsummaryrefslogtreecommitdiff
path: root/doc/dev/index.rst
diff options
context:
space:
mode:
authorLoek Le Blansch <loek.le-blansch.pv@renesas.com>2025-10-30 08:11:35 +0100
committerLoek Le Blansch <loek.le-blansch.pv@renesas.com>2025-10-30 08:11:35 +0100
commitb18d0b52a06bd7d36af0768235ac6f7a07cde813 (patch)
tree6f4a25fa7c594b61a01c40c15416b1645e0d752f /doc/dev/index.rst
parentedc7fa6838f700ab51f4f7ba1820b412eed66888 (diff)
more docs
Diffstat (limited to 'doc/dev/index.rst')
-rw-r--r--doc/dev/index.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/dev/index.rst b/doc/dev/index.rst
index 66bd679..523e6a9 100644
--- a/doc/dev/index.rst
+++ b/doc/dev/index.rst
@@ -109,6 +109,10 @@ The configuration file is a Python file sourced from ``ptconfig.py`` relative to
This file is a regular Python source file and can contain any arbitrary code.
Any global definitions with an identical name to a member variable of the :any:`Config` class will override the global configuration instance's value.
+The main method in which patchtree is configured is by creating subclasses of its internal classes and overriding its methods.
+In order to facilitate this, the type of most classes is read from the :any:`Config` dataclass instead of being instantiated directly.
+Please take a look at the :ref:`api` for more info.
+
For example:
.. code:: none