From 02291433a93c5b4fd13eb01f5f13e6491409c0cc Mon Sep 17 00:00:00 2001
From: Tania Allard <taniar.allard@gmail.com>
Date: Tue, 3 Dec 2024 22:26:20 +0000
Subject: [PATCH] ENH - Add logo and favicon to docs (#114)

---
 docs/source/_static/{images => }/ai-stack-logo.svg |   0
 docs/source/_static/{images => }/favicon.png       | Bin
 docs/source/conf.py                                |   4 +++-
 docs/source/contributing.md                        |   1 +
 docs/source/index.html                             |   6 +++---
 docs/source/tutorials.md                           |   4 +++-
 6 files changed, 10 insertions(+), 5 deletions(-)
 rename docs/source/_static/{images => }/ai-stack-logo.svg (100%)
 rename docs/source/_static/{images => }/favicon.png (100%)

diff --git a/docs/source/_static/images/ai-stack-logo.svg b/docs/source/_static/ai-stack-logo.svg
similarity index 100%
rename from docs/source/_static/images/ai-stack-logo.svg
rename to docs/source/_static/ai-stack-logo.svg
diff --git a/docs/source/_static/images/favicon.png b/docs/source/_static/favicon.png
similarity index 100%
rename from docs/source/_static/images/favicon.png
rename to docs/source/_static/favicon.png
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 61ea950..c97b04a 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -31,7 +31,8 @@
 html_title = 'JAX AI Stack'
 html_static_path = ['_static']
 html_css_files = ['css/custom.css']
-html_favicon = '_static/images/favicon.png'
+html_logo = '_static/ai-stack-logo.svg'
+html_favicon = '_static/favicon.png'
 
 # Theme-specific options
 # https://sphinx-book-theme.readthedocs.io/en/stable/reference.html
@@ -42,6 +43,7 @@
     'path_to_docs': 'docs/source/',
     'use_repository_button': True,
     'navigation_with_keys': True,
+    'home_page_in_toc': True,
 }
 
 exclude_patterns = [
diff --git a/docs/source/contributing.md b/docs/source/contributing.md
index 9bf1810..b7affa5 100644
--- a/docs/source/contributing.md
+++ b/docs/source/contributing.md
@@ -81,6 +81,7 @@ git commit -m "update new tutorial"  # commit to the branch
 To build the documentation locally, you can run the following command:
 
 ```bash
+# from the root of the repository
 sphinx-build -b html docs/source docs/_build/html
 ```
 
diff --git a/docs/source/index.html b/docs/source/index.html
index eb64b49..8ae6942 100644
--- a/docs/source/index.html
+++ b/docs/source/index.html
@@ -1,9 +1,9 @@
 <div class="doc-body">
     <section class="hero">
         <div>
-            <span><img src="./_static/images/ai-stack-logo.svg"/><h1>JAX AI Stack</h1></span>
+            <span><img src="./_static/ai-stack-logo.svg"/><h1>JAX AI Stack</h1></span>
             <p>Flexible, scalable components for AI research and development</p>
-            <a class="button button-primary" href="https://jax-ai-stack.readthedocs.io/en/latest/tutorials.html">Get started</a>
+            <a class="button button-primary" href="./tutorials.html">Get started</a>
         </div>
         <img src="./_static/images/hero.svg" class="hero-image">
     </section>
@@ -48,7 +48,7 @@ <h3>JAX AI Stack</h3>
                 <li>ml_dtypes - NumPy dtype extensions for machine learning.</li>
                 <li>Optional data loading libraries (Grain or tf.data)</li>
             </ul>
-            <a class="button button-primary" href="https://jax-ai-stack.readthedocs.io/en/latest/tutorials.html">Get started</a>
+            <a class="button button-primary" href="./tutorials.html">Get started</a>
         </div>
     </section>
     <section class="image-section">
diff --git a/docs/source/tutorials.md b/docs/source/tutorials.md
index 3370597..f26a7dc 100644
--- a/docs/source/tutorials.md
+++ b/docs/source/tutorials.md
@@ -1,6 +1,8 @@
 # Tutorials
 
-*Note: this is a work in progress; visit again soon for updated content!*
+```{note}
+This is a work in progress; visit again soon for updated content!
+```
 
 The following tutorials are meant as an intro to the full stack: