Include logo in documentation and README.md

IFCA-Advanced-Computing · Feb 18, 2020 · be7c0bc · be7c0bc
1 parent 015b389
commit be7c0bc
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # caso
 
+<img src="https://github.com/IFCA/caso/blob/master/doc/source/static/caso.png" width="300">
+
 [![Travis](https://img.shields.io/travis/IFCA/caso.svg)](https://travis-ci.org/IFCA/caso)
 [![Coveralls](https://img.shields.io/coveralls/IFCA/caso.svg)](https://coveralls.io/github/IFCA/caso)
 [![PyPI](https://img.shields.io/pypi/v/caso.svg)](https://pypi.python.org/pypi/caso)

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -52,11 +52,24 @@
 
 # -- Options for HTML output --------------------------------------------------
 
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+html_theme_options = {
+    'logo_only': False,
+    'collapse_navigation': False,
+}
+
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
 # html_theme_path = ["."]
 # html_theme = '_theme'
-# html_static_path = ['static']
+html_static_path = ['static']
+html_logo = "static/caso.png"
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = '%sdoc' % project

diff --git a/doc/source/static/caso.png b/doc/source/static/caso.png
diff --git a/test-requirements.txt b/test-requirements.txt
@@ -8,7 +8,8 @@ coverage>=3.6
 discover
 fixtures>=1.3.1
 python-subunit>=0.0.18
-sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2
+sphinx>=1.6.2 # BSD
+sphinx_rtd_theme
 oslosphinx>=2.5.0 # Apache-2.0
 testrepository>=0.0.18
 testscenarios>=0.4