render README contents in docstring-based API docs (#20)

slayoo · web-flow · commit 6ba81414593e · 2024-05-31T00:02:18.000+02:00
diff --git a/open_atmos_jupyter_utils/__init__.py b/open_atmos_jupyter_utils/__init__.py
@@ -1,5 +1,5 @@
 """
-utility routines used in PySDM and PyMPDATA example Jupyter notebooks
+.. include::../README.md
 """
 from open_atmos_jupyter_utils.pip_install_on_colab import pip_install_on_colab
 from open_atmos_jupyter_utils.temporary_file import TemporaryFile
