diff options
author | Luca Muscariello <muscariello@ieee.org> | 2020-02-12 13:49:52 +0100 |
---|---|---|
committer | Luca Muscariello <muscariello@ieee.org> | 2020-02-12 17:51:13 +0100 |
commit | 56e29ea01914681f394e3a0af4169936079858a7 (patch) | |
tree | 2b364c9da3a44637e9e2ba87b7009424ad8b192b /docs/README.md | |
parent | 202c6bc2788c943b15026c24900c321b9bbeed3c (diff) |
[HICN-512] documentation bundle using sphinx
Change-Id: I1dcbca50f7406ef2714683547b6bb32463e1baf8
Signed-off-by: Luca Muscariello <muscariello@ieee.org>
Diffstat (limited to 'docs/README.md')
-rw-r--r-- | docs/README.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..c99cf879b --- /dev/null +++ b/docs/README.md @@ -0,0 +1,49 @@ + +Building Documents + +These instructions show how documentation sources are built. + +To build your files, you can either Create a Virtual Environment using +virtualenv, which installs all the required applications for you. + +Create a Virtual Environment using virtualenv +============================ + +For more information on how to use the Python virtual environment check +out https://packaging.python.org/guides/installing-using-pip-and-virtualenv + +Get the Documents +------------------------------ + +For example start with a clone of the vpp. + +$ 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 it's own, isolated, +virtual environment, so as to not interfere with other builds that may +use different versions of software. + +Build the html files +---------------------------- + +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 +------------------------ + +If there are no errors during the build process, you should now have an +index.html file in your hicn/docs/build/html directory, which you can +then view in your browser. |