diff options
| author |   Uli Kleber <ulrich.kleber@huawei.com> | 2015-12-18 11:35:35 +0100 |
|---|---|---|
| committer | Uli Kleber <ulrich.kleber@huawei.com> | 2015-12-18 15:01:17 +0100 |
| commit | a7b9a43192c9d4c1245839e28eb5fc0748122aa3 (patch) | |
| tree | 13b73b200307fd47cd82b1f4cf9c2a175ac5c32f /docs/opnfvsecguide/getting_started.rst | |
| parent | be1b876c56adee484957f8a8f1c614eacdc828f5 (diff) | |
Fix Line Length etc for existing docs
Jira: DOCS-68
Fixing errors reported by the new tooling.
platformoverview/index.rst will be fixed with the new platformoverview
document (see separate patch)
corrected importing logo images
Change-Id: I08f73dcfeef4f2ff3a38a0372491a46798b4026b
Signed-off-by: Uli Kleber <ulrich.kleber@huawei.com>
Diffstat (limited to 'docs/opnfvsecguide/getting_started.rst')
| -rw-r--r-- | docs/opnfvsecguide/getting_started.rst | 12 |
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 |