From d4d429160874ac2ed99ceb7b31ec0b2fd04124c5 Mon Sep 17 00:00:00 2001 From: Julien Schueller Date: Thu, 18 Jan 2024 10:49:12 +0100 Subject: [PATCH] Doc: Fix rst --- README.rst | 2 -- doc/Makefile | 2 +- doc/index.rst | 2 ++ otwrapy/_otwrapy.py | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 3a3734d..5f31b75 100644 --- a/README.rst +++ b/README.rst @@ -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 `_, with its users as the target diff --git a/doc/Makefile b/doc/Makefile index f37a4d5..87b73a2 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS = +SPHINXOPTS = -W SPHINXBUILD = sphinx-build PAPER = BUILDDIR = ../build/ diff --git a/doc/index.rst b/doc/index.rst index 834fb84..f1ce9f3 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,6 +1,8 @@ Welcome to otwrapy's documentation! =================================== +.. currentmodule:: otwrapy + .. include:: ../README.rst diff --git a/otwrapy/_otwrapy.py b/otwrapy/_otwrapy.py index 816756c..0a1b0c2 100644 --- a/otwrapy/_otwrapy.py +++ b/otwrapy/_otwrapy.py @@ -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.