4 Development Environment
5 #######################
7 All project data such as formatting guidelines, and upstream mapping is documented via sphinx
8 which uses reStructuredText
13 Use of a virtual environment is recommended, as not only is it a quick easy form of
14 getting the needed modules in place, it isolates the module versions to a project.
16 From within your inspector directory, set up a new virtualenv::
20 Activate the new virtual environment::
22 source venv/bin/activate
24 Install requirements::
26 pip install -r requirements.txt
31 To get started with sphinx, visit the main tutorial which will provide a primer
32 `http://sphinx-doc.org/tutorial.html`
34 Hack your changes into opnfv-security-guide/source
40 From here you can run a basic python web server or just navigate to the
41 file:///<repo>/opnfv-security-guide/build/html/index.html in your browser