4 Anyone is welcome to make additions, raise bugs, and fix issues within this Documentation.
5 To do so, you will however need to first get an enviroment set up.
7 Development Environment
8 #######################
10 All project data such as formatting guidelines, and upstream mapping is documented via sphinx
11 which uses reStructuredText
13 It is recommended that you use a python virtualenv to keep things clean and contained.
18 Use of a virtual environment is recommended, as not only is it a quick easy form of
19 getting the needed modules in place, it isolates the module versions to a project.
21 From within your inspector directory, set up a new virtualenv::
25 Activate the new virtual environment::
27 source venv/bin/activate
29 Install requirements::
31 pip install -r requirements.txt
36 To get started with sphinx, visit the main tutorial which will provide a primer `http://sphinx-doc.org/tutorial.html`
38 Hack your changes into opnfv-security-guide/source
44 From here you can run a basic python web server or just navigate to the
45 file:///<repo>/opnfv-security-guide/build/html/index.html in your browser