path: root/docs/README.md
diff options
Diffstat (limited to 'docs/README.md')
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
index be7f4e6..431d1b8 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -15,16 +15,20 @@ out <https://packaging.python.org/guides/installing-using-pip-and-virtualenv>
For example start with a clone of the hicn.
$ git clone <https://gerrit.fd.io/r/hicn>
$ cd hicn
# Install the virtual environment
$ python3 -m pip install --user virtualenv
$ python3 -m virtualenv env
$ source env/bin/activate
$ pip install -r docs/etc/requirements.txt
$ cd docs
Which installs all the required applications into its own, isolated,
virtual environment, so as to not interfere with other builds that may
@@ -35,7 +39,9 @@ use different versions of software.
Be sure you are in your hicn/docs directory, since that is where Sphinx will
look for your conf.py file, and build the documents into an index.html file
$ make html
# View the results