From 36c325c2cac0ac597c5885f9ca5d401558ece74a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Piotr=20Ma=C5=9Blanka?= <piotr.maslanka@henrietta.com.pl>
Date: Mon, 29 Mar 2021 16:05:37 +0200
Subject: [PATCH] docs fix

---
 docs/index.rst | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/docs/index.rst b/docs/index.rst
index 7c93695..3ab63ce 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -31,8 +31,8 @@ Do it via
 
 All dependencies will be installed automatically.
 
-Mandatory reading
-=================
+Mandatory reading and limitations
+=================================
 
 Take a look at example_ on how to multi-build your Cython extensions.
 
@@ -41,6 +41,17 @@ Take a look at example_ on how to multi-build your Cython extensions.
 Don't place modules compiled that way in root .py file's top level imports.
 Wrap them in a layer of indirection instead!
 
+So if your module is called :code:`example`, make a :code:`start_example/__main__.py` with
+the following code:
+
+.. code-block:: python
+
+    if __name__ == '__main__':
+        from example import run
+        run()
+
+Or however you do start your application.
+
 This applies to unit tests as well!
 
 When something goes wrong (eg. the application throws an unhandled exception)
-- 
GitLab