Document the new parser utility functions

zeroSteiner · Apr 6, 2024 · 88751ba · 88751ba
1 parent 53a3dec
commit 88751ba
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 1 deletion.
diff --git a/docs/source/rule_engine/index.rst b/docs/source/rule_engine/index.rst
@@ -9,6 +9,6 @@
    builtins.rst
    engine.rst
    errors.rst
-   parser.rst
+   parser/index.rst
    suggestions.rst
    types.rst
diff --git a/docs/source/rule_engine/parser.rst → docs/source/rule_engine/parser/index.rst b/docs/source/rule_engine/parser.rst → docs/source/rule_engine/parser/index.rst
@@ -7,6 +7,12 @@
 This module contains the parsing logic for taking rule text in the specified grammar and converting it to an abstract
 syntax tree that can later be evaluated.
 
+.. toctree::
+   :maxdepth: 2
+   :titlesonly:
+
+   utilities.rst
+
 Classes
 -------
 

diff --git a/docs/source/rule_engine/parser/utilities.rst b/docs/source/rule_engine/parser/utilities.rst
@@ -0,0 +1,16 @@
+:mod:`utilities`
+=======================
+
+.. module:: rule_engine.parser.utilities
+   :synopsis:
+
+This module contains utility functions for parsing various strings.
+
+Functions
+---------
+
+.. autofunction:: parse_datetime
+
+.. autofunction:: parse_float
+
+.. autofunction:: parse_timedelta