blob: 683aa2d14941ea1e18a0425b3340e80c75df2589 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
|
How to Contribute
-----------------
Anyone is welcome to make additions, raise bugs, and fix issues within this Documentation.
To do so, you will however need to first get an enviroment set up.
Development Environment
#######################
All project data such as formatting guidelines, and upstream mapping is documented via sphinx
which uses reStructuredText
It is recommended that you use a python virtualenv to keep things clean and contained.
VirtualEnv
**********
Use of a virtual environment is recommended, as not only is it a quick easy form of
getting the needed modules in place, it isolates the module versions to a project.
From within your inspector directory, set up a new virtualenv::
virtualenv venv
Activate the new virtual environment::
source venv/bin/activate
Install requirements::
pip install -r requirements.txt
Sphinx Basics
*************
To get started with sphinx, visit the main tutorial which will provide a primer `http://sphinx-doc.org/tutorial.html`
Hack your changes into opnfv-security-guide/source
To compile changes:
make html
From here you can run a basic python web server or just navigate to the
file:///<repo>/opnfv-security-guide/build/html/index.html in your browser
|
