From db9410612fb3c9c30ef2ab7c867ee69d624e8590 Mon Sep 17 00:00:00 2001 From: andrewgryan Date: Wed, 2 Oct 2019 15:44:49 +0100 Subject: [PATCH] Add link to miniconda in the developer guide (#149) --- doc/source/guide.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/source/guide.rst b/doc/source/guide.rst index bba8c5fcc..653c517f1 100644 --- a/doc/source/guide.rst +++ b/doc/source/guide.rst @@ -78,8 +78,9 @@ to set an upstream branch. For example, Development environment ----------------------- -It is recommended to develop FOREST in a virtual environment of some kind. -The repository ships with a ``setup.py`` that should be suitable to +It is recommended to develop FOREST in a virtual environment of some kind, +we recommend miniconda_ since it's fairly light weight. The repository ships with +a ``setup.py`` that should be suitable to use inside a virtual environment, either ``venv`` or ``conda``. Once you've created and activated an environment it should be possible to set the code base to development mode. @@ -119,3 +120,4 @@ sure we don't accidentally deprecate your feature. .. _issues: https://github.com/informatics-lab/forest/issues .. _projects: https://github.com/informatics-lab/forest/projects .. _pytest: https://docs.pytest.org/en/latest +.. _miniconda: https://docs.conda.io/en/latest/miniconda.html