feat(book): add new features to _config.yml and _toc.yml

entelecheia · Jul 27, 2023 · 2a89341 · 2a89341
1 parent d9eccf8
commit 2a89341
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 4 deletions.
diff --git a/book/_config.yml b/book/_config.yml
@@ -8,7 +8,7 @@
 title: "ThematOS" # The title of the book. Will be placed in the left navbar.
 author: "Young Joon Lee" # The author of the book
 copyright: "2023" # Copyright year to be placed in the footer
-# logo: logo.png # A path to the book logo
+# logo: Path to the book logo
 
 # Force re-execution of notebooks on each build.
 # See https://jupyterbook.org/content/execute.html
@@ -38,9 +38,15 @@ repository:
 html:
   use_issues_button: true
   use_repository_button: true
+  use_edit_page_button: true
+  favicon: https://assets.entelecheia.ai/favicon.png # favicon: Path to the favicon image
+  google_analytics_id: G-RGCZCJ4ZZF # google_analytics_id: Google Analytics ID
 
 sphinx:
   config:
+    html_extra_path: ["assets"]
+    bibtex_reference_style: author_year
+    mathjax_path: https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
     intersphinx_mapping:
       ebp:
         - "https://executablebooks.org/en/latest/"
@@ -64,17 +70,23 @@ sphinx:
         - "https://sphinx-proof.readthedocs.io/en/latest/"
         - null
     hoverxref_intersphinx:
-     - "sphinxproof"
+      - "sphinxproof"
     mathjax3_config:
       tex:
         macros:
           "N": "\\mathbb{N}"
           "floor": ["\\lfloor#1\\rfloor", 1]
           "bmat": ["\\left[\\begin{array}"]
           "emat": ["\\end{array}\\right]"]
+    add_module_names: false
+    autosummary_generate: true
 
   extra_extensions:
     - sphinx.ext.intersphinx
+    - sphinx.ext.autodoc
+    - sphinx.ext.autosummary
+    - sphinx.ext.napoleon
+    - sphinx.ext.viewcode
     - sphinx_inline_tabs
     - sphinx_proof
     - sphinx_examples
@@ -83,3 +95,9 @@ sphinx:
     - sphinxcontrib.video
     - sphinxcontrib.mermaid
     - sphinx_thebe
+    - sphinx_carousel.carousel
+    - sphinxcontrib.lastupdate
+
+launch_buttons:
+  colab_url: "https://colab.research.google.com"
+  thebe: true
diff --git a/book/_toc.yml b/book/_toc.yml
@@ -4,5 +4,6 @@
 format: jb-book
 root: index
 chapters:
-- file: usage
-- file: examples
+  - file: usage
+  - file: api
+  - file: examples