5 This repository was created as a private staring point for the vpp documentation
6 project. It is expected that it will be used as a sandbox that can be used to
7 evaluate and comment on the new fd.io document structure.
9 Build and Load Instructions
10 ===========================
11 I build and load the documents using a mac, but these instuctions should be portable
12 to any platform. I used the Python virtual environment.
14 For more information on how to use the Python virtual enviroment check out
15 `Installing packages using pip and virtualenv`_.
17 .. _`Installing packages using pip and virtualenv`: https://packaging.python.org/guides/installing-using-pip-and-virtualenv/
21 .. code-block:: console
23 git clone https://github.com/fdioDocs/vpp-docs
26 2. Install the virtual environment
28 .. code-block:: console
30 python -m pip install --user virtualenv
31 python -m virtualenv env
32 source env/bin/activate
33 pip install -r etc/requirements.txt
37 To exit from the virtual environment execute:
39 .. code-block:: console
43 3. Build the html files
45 .. code-block:: console
52 To view the results start a browser and open the file:
54 .. code-block:: console
56 <THE CLONED DIRECTORY>/docs/_build/html/index.html