[rtems-docs commit] Add virtualenv to the README.txt as the preferred host support.

Chris Johns chrisj at rtems.org
Fri Apr 3 00:12:04 UTC 2020


Module:    rtems-docs
Branch:    master
Commit:    3f1622e40ee1daf192792f946db6184c7c9c7c88
Changeset: http://git.rtems.org/rtems-docs/commit/?id=3f1622e40ee1daf192792f946db6184c7c9c7c88

Author:    Chris Johns <chrisj at rtems.org>
Date:      Fri Apr  3 11:08:43 2020 +1100

Add virtualenv to the README.txt as the preferred host support.

---

 README.txt | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.txt b/README.txt
index cdd44fd..9fd2165 100644
--- a/README.txt
+++ b/README.txt
@@ -101,6 +101,26 @@ command.
 
 Please add your host as you set it up.
 
+The best environment to use is `virtualenv`. It can create a specific python
+environment using `pip`.
+
+Virtualenv
+~~~~~~~~~~
+
+Create a directory to house the virtualenv, create the envrionment and the
+activate it:
+
+  $ mkdir sphinx
+  $ virtualenv sphinx
+  $ . ./sphinx/bin/activate
+
+The prompt will now change. You can install Sphinx with:
+
+  $ pip install sphinx
+  $ pip install sphinxcontrib-bibtex
+
+When you have finished you enter `deactivate`.
+
 Sphinx Per User Install
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -190,7 +210,7 @@ Python 3:
 
 By default, CentOS 7 has Python 2.x. Luckily they now have Software
 Collections which lets you install and use a "collection" of newer
-software. As root, 
+software. As root,
 
   # yum install centos-release-scl
   # yum install rh-python36



More information about the vc mailing list