MLCube documentation update (#283)

- Removing unused assets (various icons, `site.webmanifest` file). - Removing `mkdocs-requirements.txt` in the root directory (use `docs/requirements.txt` instead now.). - Adding MLC logo and changing color scheme to match other MLCommons web sites.
mlcommons · Dec 9, 2022 · e021ce3 · e021ce3
1 parent 707edfd
commit e021ce3
Show file tree

Hide file tree

Showing 12 changed files with 29 additions and 140 deletions.
diff --git a/.github/workflows/docs-site.yml b/.github/workflows/docs-site.yml
@@ -18,7 +18,7 @@ jobs:
       - name: Install Python dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r mkdocs-requirements.txt
+          pip install -r docs/requirements.txt
       - name: Build Docs
         working-directory: './'
         run: |

diff --git a/docs/assets/android-chrome-192x192.png b/docs/assets/android-chrome-192x192.png
diff --git a/docs/assets/android-chrome-512x512.png b/docs/assets/android-chrome-512x512.png
diff --git a/docs/assets/apple-touch-icon.png b/docs/assets/apple-touch-icon.png
diff --git a/docs/assets/favicon-16x16.png b/docs/assets/favicon-16x16.png
diff --git a/docs/assets/favicon-32x32.png b/docs/assets/favicon-32x32.png
diff --git a/docs/assets/logo.png b/docs/assets/logo.png
diff --git a/docs/assets/site.webmanifest b/docs/assets/site.webmanifest
diff --git a/docs/assets/stylesheets/circular.css b/docs/assets/stylesheets/circular.css
diff --git a/docs/mkdocs-requirements.txt → docs/requirements.txt b/docs/mkdocs-requirements.txt → docs/requirements.txt
@@ -1,4 +1,3 @@
-flake8>=3.7.8
 mkdocs>=1.0.4
 mkdocs-material>=4.4.0
 mkdocs-click

diff --git a/mkdocs-requirements.txt b/mkdocs-requirements.txt
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,7 +1,10 @@
-site_name: 'MLCube'
-site_description: 'Documentation site for MLCube'
-site_author: '<MLPerf.org> [email protected]'
-docs_dir: 'docs/'
+site_name: MLCube
+site_description: Documentation site for MLCube
+site_author: <mlcommons.org> [email protected]
+docs_dir: docs/
+
+repo_url: https://github.com/mlcommons/mlcube
+repo_name: mlcommons/mlcube
 
 nav:
   - Home: index.md
@@ -25,18 +28,30 @@ nav:
     - GCP Runner: runners/gcp-runner.md
 
 theme:
-  name: 'material'
-  favicon: 'assets/favicon.ico'
+  features:
+    - search.suggest
+    - search.highlight
+    - search.share
+  name: material
+  logo: assets/logo.png
+  favicon: assets/favicon.ico
   language: 'en'
   palette:
-    primary: 'blue'
-    accent: 'blue'
-  font:
-    text: 'Circular'
-    code: 'Inconsolata'
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: teal
+      toggle:
+        icon: material/toggle-switch-off-outline
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: teal
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to light mode
 
-extra_css:
-  - 'assets/stylesheets/circular.css'
+plugins:
+  - search
 
 markdown_extensions:
   - admonition