Added further documentation updates

docs/CMakeLists.txt

@@ -66,5 +66,10 @@ add_custom_target(gendocsall ALL
         -E copy
         ${PROJECT_SOURCE_DIR}/CNAME
         ${SPHINX_BUILD}/CNAME
+# Copy the custom asset folder
+    COMMAND ${CMAKE_COMMAND}
+        -E copy_directory
+        ${PROJECT_SOURCE_DIR}/docs/assets/
+        ${SPHINX_BUILD}/_static/
     DEPENDS gensphinx)
 

docs/assets/custom.css

@@ -0,0 +1,3 @@
+.md-nav__title--site {
+    display: none;
+}

docs/conf.py

@@ -19,9 +19,11 @@
 import sys
 import os
 import kp
+import sphinx_material
 
 project = 'Vulkan Kompute'
 copyright = '2020, The Institute for Ethical AI & Machine Learning'
+html_title = "Vulkan Kompute Documentation (Python & C++)"
 author = 'Alejandro Saucedo'
 
 # The full version, including alpha/beta/rc tags
@@ -67,20 +69,31 @@ html_theme = 'sphinx_material'
 
 if html_theme == 'sphinx_material':
     html_theme_options = {
-        'nav_title': 'Vulkan Kompute',
+        'google_analytics_account': 'G-F9LD9HL8LW',
-        #'google_analytics_account': 'UA-XXXXX',
+        'base_url': 'https://kompute.cc',
-        #'base_url': 'https://project.github.io/project',
         'color_primary': 'red',
         'color_accent': 'light-blue',
         'repo_url': 'https://github.com/EthicalML/vulkan-kompute/',
         'repo_name': 'Vulkan Kompute',
-        'globaltoc_depth': 3,
+        'globaltoc_depth': 2,
         'globaltoc_collapse': False,
         'globaltoc_includehidden': False,
+        "repo_type": "github",
+        "nav_links": [
+            {
+                "href": "https://github.com/EthicalML/vulkan-kompute/",
+                "internal": False,
+                "title": "Kompute Repo",
+            },
+        ]
     }
 
+    extensions.append("sphinx_material")
+    html_theme_path = sphinx_material.html_theme_path()
+    html_context = sphinx_material.get_html_context()
+
 html_sidebars = {
-    "**": ["logo-text.html", "globaltoc.html", "searchbox.html"]
+    "**": ["logo-text.html", "globaltoc.html",  "localtoc.html", "searchbox.html"]
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
@@ -88,4 +101,8 @@ html_sidebars = {
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+html_css_files = [
+    'custom.css',
+]
+
 

docs/index.rst

@@ -8,18 +8,31 @@ Index
 --------
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 0
+
+    Documentation Home <https://kompute.cc/>
+
+.. toctree::
     :titlesonly:
+    :caption: C++ Documentation:
 
     C++ Simple & Advanced Examples <overview/advanced-examples>
     C++ Memory Management Principles <overview/memory-management>
     C++ Build System Deep Dive <overview/build-system>
     C++ Converting GLSL/HLSL Shaders to Cpp Headers <overview/shaders-to-headers>
     C++ Class Documentation & Reference <overview/reference>
-    ----
+
+.. toctree::
+    :titlesonly:
+    :caption: Python Documentation:
+
     Python Package Overview & Examples <overview/python-package>
     Python Class Documentation & Reference <overview/python-reference>
-    ----
+
+.. toctree::
+    :titlesonly:
+    :caption: Concepts & Deep Dives:
+
     CI, Docker Images & Tests <overview/ci-tests.rst>
     Asynchronous & Parallel Operations <overview/async-parallel>
     Mobile App Integration (Android) <overview/mobile-android>