From: Fatih Degirmenci Date: Thu, 3 Dec 2015 13:13:16 +0000 (+0100) Subject: Remove etc and source folder from yardstick documentation X-Git-Tag: brahmaputra.1.0~148 X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F15%2F3915%2F2;p=yardstick.git Remove etc and source folder from yardstick documentation conf.py and logo will come from releng which is common for all projects. The directory structure in docs folder has not been decided yet so this change does not require you to change your current way of working. Once this directory structure is decided by opnfvdocs and releng, the changes need to be reflected back to all projects, including yardstick. Change-Id: If0558474a819f4a44e34f790d26c5486751b8266 Signed-off-by: Fatih Degirmenci --- diff --git a/docs/etc/conf.py b/docs/etc/conf.py deleted file mode 100644 index d433d1d96..000000000 --- a/docs/etc/conf.py +++ /dev/null @@ -1,34 +0,0 @@ -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 Yardstick', 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 Yardstick: NFV Infrastructure Verification' -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 deleted file mode 100644 index 1519503eb..000000000 Binary files a/docs/etc/opnfv-logo.png and /dev/null differ diff --git a/docs/source/index.rst b/docs/index.rst similarity index 92% rename from docs/source/index.rst rename to docs/index.rst index 0a77ac03d..36a78321a 100644 --- a/docs/source/index.rst +++ b/docs/index.rst @@ -2,12 +2,6 @@ Add chapters and user guides using the root `toctree` directive. -.. image:: ../etc/opnfv-logo.png - :height: 40 - :width: 200 - :alt: OPNFV - :align: left - ================= Yardstick Project ================= diff --git a/docs/source/templates/Yardstick_task_templates.rst b/docs/templates/Yardstick_task_templates.rst similarity index 100% rename from docs/source/templates/Yardstick_task_templates.rst rename to docs/templates/Yardstick_task_templates.rst diff --git a/docs/source/templates/testcase_description_template.rst b/docs/templates/testcase_description_template.rst similarity index 100% rename from docs/source/templates/testcase_description_template.rst rename to docs/templates/testcase_description_template.rst diff --git a/docs/source/templates/testcase_description_v2_template.rst b/docs/templates/testcase_description_v2_template.rst similarity index 100% rename from docs/source/templates/testcase_description_v2_template.rst rename to docs/templates/testcase_description_v2_template.rst diff --git a/docs/source/user_guides/framework/03-installation.rst b/docs/user_guides/framework/03-installation.rst similarity index 100% rename from docs/source/user_guides/framework/03-installation.rst rename to docs/user_guides/framework/03-installation.rst diff --git a/docs/source/vTC/README.rst b/docs/vTC/README.rst similarity index 100% rename from docs/source/vTC/README.rst rename to docs/vTC/README.rst diff --git a/docs/source/vTC/abbreviations.rst b/docs/vTC/abbreviations.rst similarity index 100% rename from docs/source/vTC/abbreviations.rst rename to docs/vTC/abbreviations.rst