Add navbar logo

docs/environment.yml

@@ -4,6 +4,7 @@ channels:
   - conda-forge
 
 dependencies:
-  - sphinx
+  - python=3.5
+  - sphinx_rtd_theme
   - pip:
     - breathe

docs/source/conf.py

@@ -9,6 +9,12 @@
 if on_rtd:
     subprocess.call('cd ..; doxygen', shell=True)
 
+import sphinx_rtd_theme
+
+html_theme = "sphinx_rtd_theme"
+
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
 extensions = ['breathe']
 breathe_projects = { 'xsimd': '../xml' }
 templates_path = ['_templates']
@@ -18,6 +24,8 @@
 copyright = '2016, Johan Mabille and Sylvain Corlay'
 author = 'Johan Mabille and Sylvain Corlay'
 
+html_logo = 'quantstack-white.svg'
+
 exclude_patterns = []
 highlight_language = 'c++'
 pygments_style = 'sphinx'

docs/source/index.rst

@@ -4,15 +4,18 @@
 
    The full license is in the file LICENSE, distributed with this software.
 
-xsimd
-=====
+.. image:: http://quantstack.net/assets/images/xsimd.svg
+   :alt: xsimd
 
 C++ wrappers for SIMD intrinsics.
 
-`xsimd` requires a modern C++ compiler supporting C++11. The following C+ compilers are supported:
+Introduction
+------------
+
+`xsimd` requires a modern C++ compiler supporting C++11. The following C++ compilers are supported:
 
 - On Windows platforms, Visual C++ 2015 Update 2, or more recent
-- On Unix platforms, gcc 4.9 or recent versions of Clang
+- On Unix platforms, gcc 4.9 or a recent version of Clang
 
 Licensing
 ---------
@@ -22,9 +25,21 @@ copyright on their contributions.
 
 This software is licensed under the BSD-3-Clause license. See the LICENSE file for details.
 
+
 .. toctree::
-   :maxdepth: 3
+   :caption: INSTALLATION
+   :maxdepth: 2
 
    installation
+
+.. toctree::
+   :caption: USAGE
+   :maxdepth: 2
+
    usage
+
+.. toctree::
+   :caption: API REFERENCE
+   :maxdepth: 2
+
    api_reference