From e719d88839ba074d0c98d04cd7f0812ed317c3b1 Mon Sep 17 00:00:00 2001 From: Olivier Roques Date: Thu, 27 Feb 2020 16:57:29 +0100 Subject: [HICN-537] Update telemetry documentation Change-Id: I3f6c656164b27481e029eb72a63030bb592a6f1b Signed-off-by: Olivier Roques --- docs/README.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs/README.md') diff --git a/docs/README.md b/docs/README.md index be7f4e6df..431d1b814 100644 --- a/docs/README.md +++ b/docs/README.md @@ -15,16 +15,20 @@ out For example start with a clone of the hicn. +```bash $ git clone $ cd hicn +``` # Install the virtual environment +```bash $ 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 +```bash $ make html +``` # View the results -- cgit 1.2.3-korg