From 3dcdc9181e5783ec3e784488613cb33f496f0dd6 Mon Sep 17 00:00:00 2001 From: Tyler Goodlet Date: Mon, 10 Feb 2020 12:22:14 -0500 Subject: [PATCH] Include our `__main__.py` script ex for windows --- docs/index.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 4627546..f2e5ad3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -108,8 +108,8 @@ reactive style for IPC. Examples -------- -Note, if you are on Windows please be sure to see the gotchas section -before trying these. +Note, if you are on Windows please be sure to see the :ref:`gotchas +` section before trying these. A trynamic first scene @@ -495,6 +495,8 @@ backends. .. _#89: https://github.com/goodboy/tractor/issues/89 +.. _windowsgotchas: + Windows "gotchas" ^^^^^^^^^^^^^^^^^ On Windows (which requires the use of the stdlib's `multiprocessing` @@ -529,6 +531,11 @@ And execute as:: python -m application +As an example we use the following code to test all documented examples +in the test suite on windows: + +.. literalinclude:: ../examples/__main__.py + See `#61`_ and `#79`_ for further details. .. _freeze_support(): https://docs.python.org/3/library/multiprocessing.html#multiprocessing.freeze_support