diff options
| author |   Christopher Price <christopher.price@ericsson.com> | 2015-12-18 14:08:53 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@172.30.200.206> | 2015-12-18 14:08:53 +0000 |
| commit | 300d3d820d4af1a69117bab1343a30d470b06441 (patch) | |
| tree | 96d68a84ff7967740b6225a1488ff17cdd7efa58 /docs/opnfvsecguide/contribution.rst | |
| parent | f4b9495286c89c86846c666d1960cce395eebed1 (diff) | |
| parent | a7b9a43192c9d4c1245839e28eb5fc0748122aa3 (diff) | |
Merge "Fix Line Length etc for existing docs"
Diffstat (limited to 'docs/opnfvsecguide/contribution.rst')
| -rw-r--r-- | docs/opnfvsecguide/contribution.rst | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/docs/opnfvsecguide/contribution.rst b/docs/opnfvsecguide/contribution.rst index 954c5785e..683aa2d14 100644 --- a/docs/opnfvsecguide/contribution.rst +++ b/docs/opnfvsecguide/contribution.rst @@ -1,19 +1,22 @@ 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. +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 +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. +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. +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:: @@ -38,4 +41,5 @@ 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
\ No newline at end of file +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 |