diff options
author | Olivier Roques <oroques+fdio@cisco.com> | 2020-02-27 16:57:29 +0100 |
---|---|---|
committer | Olivier Roques <oroques+fdio@cisco.com> | 2020-02-28 19:22:29 +0100 |
commit | e719d88839ba074d0c98d04cd7f0812ed317c3b1 (patch) | |
tree | 6ede88dd22ee5fa5e096da84816f7409d7af6132 /docs/README.md | |
parent | bd8380012c308a79861e2e52919e9ff6326d45dc (diff) |
[HICN-537] Update telemetry documentation
Change-Id: I3f6c656164b27481e029eb72a63030bb592a6f1b
Signed-off-by: Olivier Roques <oroques+fdio@cisco.com>
Diffstat (limited to 'docs/README.md')
-rw-r--r-- | docs/README.md | 6 |
1 files changed, 6 insertions, 0 deletions
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 <https://packaging.python.org/guides/installing-using-pip-and-virtualenv> For example start with a clone of the hicn. +```bash $ git clone <https://gerrit.fd.io/r/hicn> $ 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 |