add logo and some emdgroup colors

Readme.md

@@ -3,6 +3,9 @@
 [![Pytest](https://github.com/emdgroup/tnmf/actions/workflows/pytest.yml/badge.svg)](https://github.com/emdgroup/tnmf/actions/workflows/pytest.yml)
 [![Build Documentation](https://github.com/emdgroup/tnmf/actions/workflows/sphinx.yml/badge.svg)](https://github.com/emdgroup/tnmf/actions/workflows/sphinx.yml)
 
-# PyTorch Transform-Invariant Non-Negative Matrix Factorization
+.. image:: doc/logos/tnmf_header.svg
+  :target: https://github.com/emdgroup/tnmf
+
+# Transform-Invariant Non-Negative Matrix Factorization
 
 A comprehensive transform-invariant NMF using Pytorch

doc/_static/css/emdgroup.css

@@ -0,0 +1,19 @@
+body {
+    font-family: Calibri,Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;
+}
+
+body, .wy-side-nav-search, .wy-nav-top {
+    background: #FFDCB9;
+}
+
+body, .math, .math span, .MathJax, .MathJax_Display, .wy-menu-vertical a, .wy-side-nav-search .wy-dropdown>a, .wy-side-nav-search>a, .wy-menu-vertical header, .wy-menu-vertical p.caption, .wy-nav-side, .wy-menu-vertical li.current>a, .wy-menu-vertical li.on a, .wy-menu-vertical li.toctree-l2 a, .wy-menu-vertical li.toctree-l3 a, .wy-menu-vertical li.toctree-l4 a, .wy-menu-vertical li.toctree-l5 a, .wy-menu-vertical li.toctree-l6 a, .wy-menu-vertical li.toctree-l7 a, .wy-menu-vertical li.toctree-l8 a, .wy-menu-vertical li.toctree-l9 a, .wy-menu-vertical li.toctree-l10 a {
+    color: #503291;
+}
+
+.wy-nav-side {
+    background: #E1C3CD;
+}
+
+.wy-menu-vertical li.current>a, .wy-menu-vertical li.on a, .wy-menu-vertical a:hover {
+    background: #96D7D2;
+}

doc/conf.py

@@ -18,8 +18,8 @@
 # -- Project information -----------------------------------------------------
 
 project = 'TransformInvariantNMF'
-copyright = '2021, Adrian Sosic, Mathias Winkel'
-author = 'Adrian Sosic, Mathias Winkel'
+copyright = '2021, Adrian Šošić, Mathias Winkel'
+author = 'Adrian Šošić, Mathias Winkel'
 
 
 # -- General configuration ---------------------------------------------------
@@ -38,6 +38,7 @@
 autoapi_options = [ 'members', 'undoc-members', 'no-private-members', 'show-inheritance', 'show-module-summary', 'special-members', 'imported-members', ]
 
 
+m2r_parse_relative_links = True
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -58,8 +59,16 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
+html_static_path = ['_static', ]
+html_logo = "logos/tnmf_logo.svg"
+html_theme_options = {
+    'logo_only': False,
+    'display_version': True,
+}
+
+html_css_files = [
+    'css/emdgroup.css',
+]
 
 intersphinx_mapping = {
     'python': ('https://docs.python.org/{.major}'.format(sys.version_info), None),