summaryrefslogtreecommitdiffstats
path: root/docs/opnfvsecguide/getting_started.rst
diff options
context:
space:
mode:
authorChristopher Price <christopher.price@ericsson.com>2015-12-18 14:08:53 +0000
committerGerrit Code Review <gerrit@172.30.200.206>2015-12-18 14:08:53 +0000
commit300d3d820d4af1a69117bab1343a30d470b06441 (patch)
tree96d68a84ff7967740b6225a1488ff17cdd7efa58 /docs/opnfvsecguide/getting_started.rst
parentf4b9495286c89c86846c666d1960cce395eebed1 (diff)
parenta7b9a43192c9d4c1245839e28eb5fc0748122aa3 (diff)
Merge "Fix Line Length etc for existing docs"
Diffstat (limited to 'docs/opnfvsecguide/getting_started.rst')
-rw-r--r--docs/opnfvsecguide/getting_started.rst12
1 files changed, 8 insertions, 4 deletions
diff --git a/docs/opnfvsecguide/getting_started.rst b/docs/opnfvsecguide/getting_started.rst
index cfa8b2f6b..e09507dd2 100644
--- a/docs/opnfvsecguide/getting_started.rst
+++ b/docs/opnfvsecguide/getting_started.rst
@@ -4,12 +4,14 @@ Getting Started
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
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::
@@ -26,7 +28,8 @@ Install requirements::
Sphinx Basics
*************
-To get started with sphinx, visit the main tutorial which will provide a primer `http://sphinx-doc.org/tutorial.html`
+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
@@ -34,4 +37,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