Add logo

CONTRIBUTING.md

@@ -80,6 +80,7 @@ We use the following Sphinx extensions to build our documentation site:
     ```python
     napoleon_custom_sections = [("Returns", "params_style")]
     ```
+- [Furo theme](https://pradyunsg.me/furo/)
 
 
 ## Coding style guide

docs/conf.py

@@ -50,22 +50,22 @@
 
 # sphinx.ext.napoleon
 # - document multiple return variables
-napoleon_custom_sections = [("Returns", "params_style")]
+napoleon_custom_sections = [('Returns', 'params_style')]
 
 # myst_parser
 # - use $...$ for inline, $$...$$ for display, and \$ for an actual dollar sign
 myst_enable_extensions = [
-    "dollarmath"
+    'dollarmath'
 ]
 
 # sphinx.ext.mathjax
 # - add common LaTeX macros
 mathjax3_config = {
     'tex': {
         'macros': {
-            'E': "{\\mathbb{E}}",
-            'R': "{\\mathbb{R}}",
-            'Z': "{\\mathbb{Z}}",
+            'E': '{\\mathbb{E}}',
+            'R': '{\\mathbb{R}}',
+            'Z': '{\\mathbb{Z}}',
         },
         # Use AMS numbering rules and support labeled equations.
         # See https://docs.mathjax.org/en/latest/input/tex/eqnumbers.html
@@ -91,7 +91,9 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 # left-sidebar title
-html_title = "SustainGym"
+html_title = 'SustainGym'
+html_logo = 'logo.png'
+html_favicon = 'favicon.ico'
 
 # include custom CSS
 html_static_path = ['_static']
@@ -104,7 +106,7 @@
 # add edit button
 # see https://pradyunsg.me/furo/customisation/edit-button/
 html_theme_options = {
-    "source_repository": "https://github.com/chrisyeh96/sustaingym/",
-    "source_branch": "main",
-    "source_directory": "docs/",
+    'source_repository': 'https://github.com/chrisyeh96/sustaingym/',
+    'source_branch': 'main',
+    'source_directory': 'docs/',
 }

docs/requirements.txt

@@ -1,5 +1,5 @@
-furo==2023.9.10
+furo==2024.01.29
 myst-parser==2.0.0
-sphinx==7.2.5
+sphinx==7.2.6
 sphinx-autoapi==3.0.0
 sphinx-copybutton==0.5.2