Branding (#228)

README.md

@@ -1,4 +1,6 @@
-<h1 align="center"> nerfactory🤘 </h1>
+<p align="center">
+  <img src="docs/imgs/logo.png" width="400" />
+</p>
 
 <p align="center"> The all-in-one repo for NeRFs </p>
 

docs/_templates/sidebar/brand.html

@@ -0,0 +1,32 @@
+{#- Hi there! You might be interested in
+https://pradyunsg.me/furo/customisation/sidebar/ Although if you're reading
+this, chances are that you're either familiar enough with Sphinx that you know
+what you're doing, or landed here from that documentation page. Hope your day's
+going well. :) -#}
+<a
+  class="sidebar-brand{% if logo %} centered{% endif %}"
+  href="{{ pathto(master_doc) }}"
+>
+  {% block brand_content %} {%- if logo_url %}
+  <div class="sidebar-logo-container">
+    <img class="sidebar-logo" src="{{ logo_url }}" alt="Logo" />
+  </div>
+  {%- endif %} {%- if theme_light_logo and theme_dark_logo %}
+  <div class="sidebar-logo-container">
+    <img
+      class="sidebar-logo only-light"
+      src="{{ pathto('_static/' + theme_light_logo, 1) }}"
+      alt="Light Logo"
+    />
+    <img
+      class="sidebar-logo only-dark"
+      src="{{ pathto('_static/' + theme_dark_logo, 1) }}"
+      alt="Dark Logo"
+    />
+  </div>
+  {%- endif %} {#- {% if not theme_sidebar_hide_name %}
+  <span class="sidebar-brand-text"
+    >{{ docstitle if docstitle else project }}</span
+  >
+  {%- endif %} -#} {% endblock brand_content %}
+</a>

docs/conf.py

@@ -76,21 +76,27 @@ myst_enable_extensions = ["amsmath", "colon_fence", "deflist", "dollarmath", "ht
 # a list of builtin themes.
 #
 html_theme = "furo"
-html_title = "nerfactory"
+html_title = ""
 
 autosectionlabel_prefix_document = True
 
 html_theme_options = {
     "light_css_variables": {
-        "color-brand-primary": "#00878e",
-        "color-brand-content": "#00878e",
+        "color-brand-primary": "#ba3e00",
+        "color-brand-content": "#ff6f00",
     },
+    "dark_css_variables": {
+        "color-brand-primary": "#fdd06c",
+        "color-brand-content": "#ff903b",
+    },
+    "light_logo": "imgs/logo.png",
+    "dark_logo": "imgs/logo-dark.png",
 }
 
 # -- Code block theme --------------------------------------------------------
 
-pygments_style = "manni"
-pygments_dark_style = "stata-dark"
+pygments_style = "one-dark"
+pygments_dark_style = "one-dark"
 
 # -- Napoleon settings -------------------------------------------------------
 

docs/index.rst

@@ -1,12 +1,17 @@
-nerfactory |:metal:|
-====================================
+
+|
+
+.. image:: _static/imgs/logo.png
+  :width: 400
+  :align: center
+  :alt: nerfactory
 
 Neural Volumetric Rendering
 """""""""""""""""""""""""""""
 
 All-in-one repository for state-of-the-art NeRFs.
 
-nerfactory |:metal:| provides a simple API that allows for a seamless and simplified end-to-end process of creating, training, and testing NeRFs.
+nerfactory provides a simple API that allows for a seamless and simplified end-to-end process of creating, training, and testing NeRFs.
 The library supports a more interpretable implementation of NeRFs by modularizing each component.
 With more modular NeRFs, not only does your code become far more user-friendly, but using this framework also makes it easier for the community to build upon your implementation. 
 

docs/tutorials/quickstart_index.rst

@@ -1,12 +1,18 @@
-nerfactory |:metal:|
-====================================
+
+|
+
+.. image:: ../_static/imgs/logo.png
+  :width: 400
+  :align: center
+  :alt: nerfactory
+
 
 Neural Volumetric Rendering
 """""""""""""""""""""""""""""
 
 All-in-one repository for state-of-the-art NeRFs.
 
-nerfactory |:metal:| provides a simple API that allows for a seamless and simplified end-to-end process of creating, training, and testing NeRFs.
+nerfactory provides a simple API that allows for a seamless and simplified end-to-end process of creating, training, and testing NeRFs.
 The library supports a more interpretable implementation of NeRFs by modularizing each component.
 With more modular NeRFs, not only does your code become far more user-friendly, but using this framework also makes it easier for the community to build upon your implementation.