From 1ee9748ba559f4ae3d05eccd0c0fb37aed627667 Mon Sep 17 00:00:00 2001 From: Mariatta Date: Tue, 14 Jan 2020 20:05:02 -0800 Subject: [PATCH] Remind user about virtualenv and using python -m --- README.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 1ba7962..476a46c 100644 --- a/README.rst +++ b/README.rst @@ -10,6 +10,14 @@ projects if you so choose, but please keep in mind that in doing so you're also choosing to accept some of the responsibility for maintaining that collective trust. -To use the theme, install it into your docs build environment via ``pip``:: +To use the theme, install it into your docs build environment via ``pip`` +(preferably in a virtual environment). - pip install python-docs-theme +1. Create and activate a virtual environment:: + + $ python -m venv env + $ source env/bin/activate + +2. Install python-docs-theme using `pip`:: + + (env)$ python -m pip install python-docs-theme