docs/opnfvsecguide/getting_started.rst

   1 Getting Started
   2 ---------------
   3
   4 Development Environment
   5 #######################
   6
   7 All project data such as formatting guidelines, and upstream mapping is documented via sphinx which uses reStructuredText
   8
   9 VirtualEnv
  10 **********
  11
  12 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.
  13
  14 From within your inspector directory, set up a new virtualenv::
  15
  16     virtualenv venv
  17
  18 Activate the new virtual environment::
  19
  20     source venv/bin/activate
  21
  22 Install requirements::
  23
  24     pip install -r requirements.txt
  25
  26 Sphinx Basics
  27 *************
  28
  29 To get started with sphinx, visit the main tutorial which will provide a primer `http://sphinx-doc.org/tutorial.html`
  30
  31 Hack your changes into opnfv-security-guide/source
  32
  33 To compile changes:
  34
  35     make html
  36
  37 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