Skip to content

Commit

Permalink
Doc: Fix rst
Browse files Browse the repository at this point in the history
  • Loading branch information
jschueller committed Jan 18, 2024
1 parent 3de4c9d commit d4d4291
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 0 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
.. image:: https://github.com/openturns/otwrapy/actions/workflows/build.yml/badge.svg?branch=master
:target: https://github.com/openturns/otwrapy/actions/workflows/build.yml

.. currentmodule:: otwrapy

`otwrapy` is a collection of tools that simplify the task of wrapping
external codes in a Python environment as well as parallelizing it. It is built
on top of `OpenTURNS <http://www.openturns.org>`_, with its users as the target
Expand Down
2 changes: 1 addition & 1 deletion doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXOPTS = -W
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = ../build/
Expand Down
2 changes: 2 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Welcome to otwrapy's documentation!
===================================

.. currentmodule:: otwrapy

.. include:: ../README.rst


Expand Down
4 changes: 2 additions & 2 deletions otwrapy/_otwrapy.py
Original file line number Diff line number Diff line change
Expand Up @@ -555,8 +555,8 @@ class Parallelizer(ot.OpenTURNSPythonFunction):
dask_args : dict (Optional)
Dictionnary parameters when using 'dask'. It must follow this form:
{'scheduler': ip adress or host name,
'workers': {'ip adress or host name': n_cpus},
'remote_python': {'ip adress or host name': path_to_bin_python}}.
'workers': {'ip adress or host name': n_cpus},
'remote_python': {'ip adress or host name': path_to_bin_python}}.
The parallelization uses SSHCluster class of dask distributed with 1 thread per worker.
When dask is chosen, the argument n_cpus is not used. The progress bar is enabled if
verbosity != 0.
Expand Down

0 comments on commit d4d4291

Please sign in to comment.