florincoras / vpp-docs

This repository will be used for the VPP documentation project

Overview

This repository was created as a private staring point for the vpp documentation project. It is expected that it will be used as a sandbox that can be used to evaluate and comment on the new fd.io document structure.

Build and Load Instructions

I build and load the documents using a mac, but these instuctions should be portable to any platform. I used the Python virtual environment.

For more information on how to use the Python virtual enviroment check out Installing packages using pip and virtualenv.

1. Get the repository

git clone https://github.com/fdioDocs/vpp-docs
cd vpp-docs

2. Install the virtual environment

python -m pip install --user virtualenv
python -m virtualenv env
source env/bin/activate
pip install -r etc/requirements.txt

Note

To exit from the virtual environment execute:

deactivate

3. Build the html files

cd docs
make html

4. View the results.

To view the results start a browser and open the file:

<THE CLONED DIRECTORY>/docs/_build/html/index.html