From 4c8d7e58bcc76bd4868b0517bdbbbb67c8c10aef Mon Sep 17 00:00:00 2001
From: DuncDennis <90915296+DuncDennis@users.noreply.github.com>
Date: Sun, 12 Mar 2023 16:41:38 +0100
Subject: [PATCH] Added simple documentation with mkdocs.

---
 src/lorenzpy/__init__.py | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/src/lorenzpy/__init__.py b/src/lorenzpy/__init__.py
index 5a81370..d9c57ab 100644
--- a/src/lorenzpy/__init__.py
+++ b/src/lorenzpy/__init__.py
@@ -1,4 +1,10 @@
-"""Python package to simulate and Measure chaotic time series."""
+"""Python package to simulate and Measure chaotic time series.
+
+Modules exported by this package:
+
+- `simulations`: Simulate various discrete and continuous chaotic dynamical systems.
+- `measures`: Measures for the chaotic dynamical systems.
+"""
 
 from . import measures, simulations