From a5a30cb5749361c14bd59c9f7e074bcebf70f8e4 Mon Sep 17 00:00:00 2001 From: pthouvenin <pierreantoine.thouvenin@gmail.com> Date: Tue, 31 Oct 2023 16:18:02 +0100 Subject: [PATCH] fix: Fixing setup instructions in readme and doc --- README.md | 5 +++-- docs/source/setup.rst | 3 ++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 243685b..d214579 100644 --- a/README.md +++ b/README.md @@ -182,8 +182,9 @@ ______________________________________________________________________ ```bash mamba activate dsgs -cd build docs/build/html +cd docs make html +open docs/build/html/index.html ``` ### Assessing code and docstring coverage @@ -206,7 +207,7 @@ To launch a single test, run a command of the form ```bash mamba activate dsgs -python -m pytest tests/models/test_crop.py +python -m pytest tests/operators/test_crop.py pytest --markers # check full list of markers availables pytest -m "not mpi" --ignore-glob=**/archive_unittest/* # run all tests not marked as mpi + ignore files in any directory "archive_unittest" mpiexec -n 2 python -m mpi4py -m pytest -m mpi # run all tests marked mpi with 2 cores diff --git a/docs/source/setup.rst b/docs/source/setup.rst index 4f4ef7f..7f5c813 100644 --- a/docs/source/setup.rst +++ b/docs/source/setup.rst @@ -144,8 +144,9 @@ The documentation can be generated in ``.html`` format using the following comma .. code-block:: bash conda activate dsgs - cd build docs/build/html + cd docs make html # compile documentation in html, latex or linkcheck + open docs/build/html/index.html Assessing code and docstring coverage -- GitLab