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
   8 which uses reStructuredText
   9
  10 VirtualEnv
  11 **********
  12
  13 Use of a virtual environment is recommended, as not only is it a quick easy form of
  14 getting the needed modules in place, it isolates the module versions to a project.
  15
  16 From within your inspector directory, set up a new virtualenv::
  17
  18     virtualenv venv
  19
  20 Activate the new virtual environment::
  21
  22     source venv/bin/activate
  23
  24 Install requirements::
  25
  26     pip install -r requirements.txt
  27
  28 Sphinx Basics
  29 *************
  30
  31 To get started with sphinx, visit the main tutorial which will provide a primer
  32 `http://sphinx-doc.org/tutorial.html`
  33
  34 Hack your changes into opnfv-security-guide/source
  35
  36 To compile changes:
  37
  38     make html
  39
  40 From here you can run a basic python web server or just navigate to the
  41 file:///<repo>/opnfv-security-guide/build/html/index.html in your browser