diff options
| author |   Stuart Mackie <wsmackie@juniper.net> | 2017-09-14 23:26:31 -0700 |
|---|---|---|
| committer | Stuart Mackie <wsmackie@juniper.net> | 2017-09-14 23:26:31 -0700 |
| commit | fd876b7dbc7d517a706b22e52bf6f0e8f79a0b4b (patch) | |
| tree | 996858dd4abe0221f8f9d54a2aeeb4ffb9971b8e /docs/development/opnfvsecguide/getting_started.rst | |
| parent | fce102283bab73ed08c292fce03e39c52f4a1fe2 (diff) | |
Docs
Change-Id: Iea3001f8414267f1535353f28d30d45daf9a3e66
Signed-off-by: Stuart Mackie <wsmackie@juniper.net>
Diffstat (limited to 'docs/development/opnfvsecguide/getting_started.rst')
| -rw-r--r-- | docs/development/opnfvsecguide/getting_started.rst | 41 |
1 files changed, 0 insertions, 41 deletions
diff --git a/docs/development/opnfvsecguide/getting_started.rst b/docs/development/opnfvsecguide/getting_started.rst deleted file mode 100644 index e09507d..0000000 --- a/docs/development/opnfvsecguide/getting_started.rst +++ /dev/null @@ -1,41 +0,0 @@ -Getting Started ---------------- - -Development Environment -####################### - -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. - -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 |