aboutsummaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md23
1 files changed, 9 insertions, 14 deletions
diff --git a/docs/README.md b/docs/README.md
index c99cf879b..d7a6c6cc8 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,27 +1,24 @@
-Building Documents
+# 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
-============================
+# 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
+out <https://packaging.python.org/guides/installing-using-pip-and-virtualenv>
-Get the Documents
-------------------------------
+# Get the Documents
-For example start with a clone of the vpp.
+For example start with a clone of the hicn.
-$ git clone https://gerrit.fd.io/r/hicn
+$ git clone <https://gerrit.fd.io/r/hicn>
$ cd hicn
-Install the virtual environment
-----------------------------------------------
+# Install the virtual environment
$ python3 -m pip install --user virtualenv
$ python3 -m virtualenv env
@@ -33,16 +30,14 @@ 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
-----------------------------
+# 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
-------------------------
+# 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