Add note about API

abravalheri · Apr 20, 2024 · 1c1538b · 1c1538b
1 parent 64a373f
commit 1c1538b
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/public_api_docs.py b/docs/public_api_docs.py
@@ -5,6 +5,13 @@
 Module Reference
 ================
 
+The public API of ``ini2toml`` is mainly composed by ``ini2toml.api``.
+Users may also find useful to import ``ini2toml.errors`` and
+``ini2toml.types`` when handling exceptions or specifying type hints.
+
+Plugin developers might try to use ``ini2toml.transformations``,
+but they should take the stability of that module with a grain of salt...
+
 .. toctree::
    :glob:
    :maxdepth: 2