Skip to content

Commit

Permalink
📝 Update doc/conf.
Browse files Browse the repository at this point in the history
  • Loading branch information
PGijsbers committed Sep 17, 2019
1 parent dec6b5a commit 110a09e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
11 changes: 6 additions & 5 deletions docs/source/api/utilities.inc
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,12 @@ Timekeeper

.. autoclass:: gama.utilities.generic.timekeeper.TimeKeeper

AsyncExecutor
~~~~~~~~~~~~~
AsyncEvaluator
~~~~~~~~~~~~~~

.. warning::
This component in particular has its own issues and will be replaced.
But I have yet to find a satisfying alternative to 'hacking' the built-in ProcessPoolExecutor.
I'm sure there are better tools out there, but I have yet to find a minimal easy multi-processing tool.
I tried using the built-in ProcessPoolExecutor, but it had short comings such as not being able to cancel
jobs while they were running.
.. autoclass:: gama.utilities.generic.async_executor.AsyncExecutor
.. autoclass:: gama.utilities.generic.async_evaluator.AsyncEvaluator
3 changes: 2 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@
# -- Adding the module to document ----------------------------------------
import os
import sys
sys.path.append(os.path.abspath('../gama'))

sys.path.insert(0, os.path.abspath('../..'))

# -- Copying Example files over -------------------------------------------
import shutil
Expand Down

0 comments on commit 110a09e

Please sign in to comment.