diff options
author | Billy O'Mahony <billy.o.mahony@intel.com> | 2016-02-09 13:23:18 +0000 |
---|---|---|
committer | Billy O'Mahony <billy.o.mahony@intel.com> | 2016-02-11 17:44:10 +0000 |
commit | 124d429e97cb57c31735ba596900d6cab50d6458 (patch) | |
tree | 2d8a8acd9794d64e75ea20579e74cf27b289b899 | |
parent | 9e423f6b53784b231ecb3c244bd7f279e94b5ffb (diff) |
docs: Reformat docs to rel/b standard.
This patch is only to comply with https://wiki.opnfv.org/documentation
any other documention short-comings should be dealt with in a further
patch.
Change-Id: Ib770c192f9ad60907b923c9d99fa351d7621c7f2
Signed-off-by: Billy O'Mahony <billy.o.mahony@intel.com>
Reviewed-by: Mark D. Gray <mark.d.gray@intel.com>
Reviewed-by: Thomas F Herbert <therbert@redhat.com>
Reviewed-by: Michal Ptacek <michalx.ptacek@intel.com>
Reviewed-by: Chris Price <christopher.price@ericsson.com>
-rw-r--r-- | docs/configguide/index.rst (renamed from docs/userguides/index.rst) | 1 | ||||
-rwxr-xr-x | docs/configguide/installation.rst (renamed from docs/userguides/installation.rst) | 0 | ||||
-rw-r--r-- | docs/etc/conf.py | 48 | ||||
-rw-r--r-- | docs/etc/opnfv-logo.png | bin | 2829 -> 0 bytes | |||
-rwxr-xr-x | docs/index.rst (renamed from docs/all/index.rst) | 11 | ||||
-rw-r--r-- | docs/userguide/index.rst | 13 | ||||
-rwxr-xr-x | docs/userguide/quickstart.rst (renamed from docs/userguides/quickstart.rst) | 0 |
7 files changed, 17 insertions, 56 deletions
diff --git a/docs/userguides/index.rst b/docs/configguide/index.rst index 6809c8e..6f84c19 100644 --- a/docs/userguides/index.rst +++ b/docs/configguide/index.rst @@ -10,5 +10,4 @@ OVSNFV Guides and Installation :numbered: :maxdepth: 3 - quickstart.rst installation.rst diff --git a/docs/userguides/installation.rst b/docs/configguide/installation.rst index ae67a94..ae67a94 100755 --- a/docs/userguides/installation.rst +++ b/docs/configguide/installation.rst diff --git a/docs/etc/conf.py b/docs/etc/conf.py deleted file mode 100644 index b8b9aff..0000000 --- a/docs/etc/conf.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2016 Open Platform for NFV Project, Inc. and its contributors -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -import datetime -import sys -import os - -try: - __import__('imp').find_module('sphinx.ext.numfig') - extensions = ['sphinx.ext.numfig'] -except ImportError: - # 'pip install sphinx_numfig' - extensions = ['sphinx_numfig'] - -# numfig: -number_figures = True -figure_caption_prefix = "Fig." - -source_suffix = '.rst' -master_doc = 'index' -pygments_style = 'sphinx' -html_use_index = False - -pdf_documents = [('index', u'OPNFV', u'OPNFV Project', u'OPNFV')] -pdf_fit_mode = "shrink" -pdf_stylesheets = ['sphinx','kerning','a4'] -#latex_domain_indices = False -#latex_use_modindex = False - -latex_elements = { - 'printindex': '', -} - -project = u'OPNFV: Template documentation config' -copyright = u'%s, OPNFV' % datetime.date.today().year -version = u'1.0.0' -release = u'1.0.0' diff --git a/docs/etc/opnfv-logo.png b/docs/etc/opnfv-logo.png Binary files differdeleted file mode 100644 index 1519503..0000000 --- a/docs/etc/opnfv-logo.png +++ /dev/null diff --git a/docs/all/index.rst b/docs/index.rst index f4b1738..4721498 100755 --- a/docs/all/index.rst +++ b/docs/index.rst @@ -7,12 +7,9 @@ ==================== Open vSwitch for NFV ==================== -Welcome to OVSNFV's documentation ! +Welcome to OVSNFV's documentation! -.. _OVSNFV: https://wiki.opnfv.org/open_vswitch_for_nfv -.. _REPO: https://opnfv.org/gerrit/ovsnfv - -OVSNFV_ is an OPNFV collaborative development project. +OVSNFV is an OPNFV collaborative development project. The OVSNFV project proposes: @@ -28,8 +25,8 @@ The OVSNFV project proposes: :maxdepth: 3 :numbered: 5 - http://artifacts.opnfv.org/ovsnfv/docs/userguides/index.html - http://artifacts.opnfv.org/ovsnfv/docs/release/index.html + ./configguide/index.rst + ./userguide/index.rst Indices diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst new file mode 100644 index 0000000..c2f593d --- /dev/null +++ b/docs/userguide/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (c) 2016 Open Platform for NFV Project, Inc. and its contributors + +****************************** +OVSNFV Guides and Installation +****************************** + +.. toctree:: + :numbered: + :maxdepth: 3 + + quickstart.rst diff --git a/docs/userguides/quickstart.rst b/docs/userguide/quickstart.rst index d8cbe60..d8cbe60 100755 --- a/docs/userguides/quickstart.rst +++ b/docs/userguide/quickstart.rst |