goodboy
/
tractor
1
0
Fork 1
Code Issues 1 Pull Requests 4 Packages Projects Releases Wiki Activity

Include our `__main__.py` script ex for windows

init_sphinx_docs
Tyler Goodlet 2020-02-10 12:22:14 -05:00
parent 20f9ccfa9e
commit 3dcdc9181e
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/index.rst
View File

@ -108,8 +108,8 @@ reactive style for IPC.
Examples Examples
-------- --------
Note, if you are on Windows please be sure to see the gotchas section Note, if you are on Windows please be sure to see the :ref:`gotchas
before trying these. <windowsgotchas>` section before trying these.
A trynamic first scene A trynamic first scene
@ -495,6 +495,8 @@ backends.
.. _#89: https://github.com/goodboy/tractor/issues/89 .. _#89: https://github.com/goodboy/tractor/issues/89
.. _windowsgotchas:
Windows "gotchas" Windows "gotchas"
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
On Windows (which requires the use of the stdlib's `multiprocessing` On Windows (which requires the use of the stdlib's `multiprocessing`
@ -529,6 +531,11 @@ And execute as::
python -m application 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. See `#61`_ and `#79`_ for further details.
.. _freeze_support(): https://docs.python.org/3/library/multiprocessing.html#multiprocessing.freeze_support .. _freeze_support(): https://docs.python.org/3/library/multiprocessing.html#multiprocessing.freeze_support