Merge "Update OPNFV Sphinx Theme"

11 files changed, 23 insertions, 20 deletions

diff --git a/opnfv-theme/MANIFEST.in b/opnfv-theme/MANIFEST.in
index a5886cd20..34bc06617 100644
--- a/opnfv-theme/MANIFEST.in
+++ b/opnfv-theme/MANIFEST.in
@@ -2,6 +2,6 @@ include *.txt
 include *.rst
 
 recursive-include sphinx_opnfv_theme *
-recursive-include sphinx_opnfv_theme/opnfv *
+recursive-include sphinx_opnfv_theme/static *
 
 global-exclude *.pyc
diff --git a/opnfv-theme/README.rst b/opnfv-theme/README.rst
index 484a7a793..c307768fb 100644
--- a/opnfv-theme/README.rst
+++ b/opnfv-theme/README.rst
@@ -12,21 +12,23 @@ Here's how to install the theme from PyPI_
 
 To install and configure the theme do the following.
 
-#. Install the theme from pypi::
+#. Install the theme from pypi:
 
-   $ pip install sphinx_opnfv_theme
+   .. code-block:: bash
+
+      $ pip install sphinx_opnfv_theme
 
 #. Configure Sphinx to use the theme:
 
-.. code-block:: python
+   .. code-block:: python
 
-   # conf.py
-   import sphinx_opnfv_theme
+      # conf.py
+      import sphinx_opnfv_theme
 
-   # ...
+      # ...
 
-   html_theme = 'opnfv'
-   html_theme_path = sphinx_opnfv_theme.get_html_theme_path()
+      html_theme = 'opnfv'
+      html_theme_path = sphinx_opnfv_theme.get_html_theme_path()
 
 Customization
 -------------
@@ -39,7 +41,7 @@ following options for the bootstrap theme::
 
   html_theme_options = {
     'bootswatch_theme': 'journal',
-    'navbar_sidebarrel': false,
+    'navbar_sidebarrel': False,
     'navbar_title': '',
   }
 
diff --git a/opnfv-theme/setup.py b/opnfv-theme/setup.py
index 5375c0940..55f55bc92 100644
--- a/opnfv-theme/setup.py
+++ b/opnfv-theme/setup.py
@@ -2,29 +2,29 @@ from setuptools import setup, find_packages
 
 from sphinx_opnfv_theme import __version__
 
-with open('README.rst') as f:
-    readme_text = f.read()
 
 setup(
     name='sphinx_opnfv_theme',
     description="OPNFV Theme for Sphinx",
-    long_description=readme_text,
+    long_description=open('README.rst').read(),
     url='https://docs.opnfv.org/',
     author='Trevor Bramwell',
     author_email='tbramwell@linuxfoundation.org',
     version=__version__,
-    entry_points = {
+    entry_points={
         'sphinx.html_themes': [
             'opnfv = sphinx_opnfv_theme',
         ]
     },
     packages=find_packages(),
-    install_requires = [
+    install_requires=[
         'sphinx_bootstrap_theme',
-        'sphinxcontrib.httpdomain',
+        'sphinxcontrib-httpdomain',
     ],
     include_package_data=True,
-    package_data = {
-        'sphinx_opnfv_theme': ['opnfv/**',]
-    },
+    package_data={'sphinx_opnfv_theme': [
+        'theme.conf',
+        'static/*',
+        '*.html',
+    ]},
 )
diff --git a/opnfv-theme/sphinx_opnfv_theme/__init__.py b/opnfv-theme/sphinx_opnfv_theme/__init__.py
index 007927521..2bf05c3ae 100644
--- a/opnfv-theme/sphinx_opnfv_theme/__init__.py
+++ b/opnfv-theme/sphinx_opnfv_theme/__init__.py
@@ -2,7 +2,7 @@
 
 from os import path
 
-__version__='0.1.1'
+__version__ = '0.2.0'
 
 
 def get_html_theme_path():
@@ -10,6 +10,7 @@ def get_html_theme_path():
     local_path = path.abspath(path.dirname(__file__))
     return [local_path]
 
+
 def setup(app):
     """Required by Sphinx to create the theme."""
     app.add_html_theme('opnfv', path.abspath(path.dirname(__file__)))
diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/layout.html b/opnfv-theme/sphinx_opnfv_theme/layout.html
index ddd674cf1..ddd674cf1 100644
--- a/opnfv-theme/sphinx_opnfv_theme/opnfv/layout.html
+++ b/opnfv-theme/sphinx_opnfv_theme/layout.html
diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/my_custom_sidebar.html b/opnfv-theme/sphinx_opnfv_theme/my_custom_sidebar.html
index 6b259bc93..6b259bc93 100644
--- a/opnfv-theme/sphinx_opnfv_theme/opnfv/my_custom_sidebar.html
+++ b/opnfv-theme/sphinx_opnfv_theme/my_custom_sidebar.html
diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/relations.html b/opnfv-theme/sphinx_opnfv_theme/relations.html
index 5bad0b562..5bad0b562 100644
--- a/opnfv-theme/sphinx_opnfv_theme/opnfv/relations.html
+++ b/opnfv-theme/sphinx_opnfv_theme/relations.html
diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/favicon.ico b/opnfv-theme/sphinx_opnfv_theme/static/favicon.ico
index bbe55ab40..bbe55ab40 100755
--- a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/favicon.ico
+++ b/opnfv-theme/sphinx_opnfv_theme/static/favicon.ico
diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/logo.png b/opnfv-theme/sphinx_opnfv_theme/static/logo.png
index 1519503eb..1519503eb 100644
--- a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/logo.png
+++ b/opnfv-theme/sphinx_opnfv_theme/static/logo.png
diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/my-styles.css b/opnfv-theme/sphinx_opnfv_theme/static/my-styles.css
index 8feb45bfd..8feb45bfd 100644
--- a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/my-styles.css
+++ b/opnfv-theme/sphinx_opnfv_theme/static/my-styles.css
diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/theme.conf b/opnfv-theme/sphinx_opnfv_theme/theme.conf
index 66424aa1f..66424aa1f 100644
--- a/opnfv-theme/sphinx_opnfv_theme/opnfv/theme.conf
+++ b/opnfv-theme/sphinx_opnfv_theme/theme.conf