diff --git a/.github/workflows/docs-site.yml b/.github/workflows/docs-site.yml index 8f6e754a..24114e7d 100644 --- 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 deleted file mode 100644 index 846f9098..00000000 Binary files a/docs/assets/android-chrome-192x192.png and /dev/null differ diff --git a/docs/assets/android-chrome-512x512.png b/docs/assets/android-chrome-512x512.png deleted file mode 100644 index 3a99948d..00000000 Binary files a/docs/assets/android-chrome-512x512.png and /dev/null differ diff --git a/docs/assets/apple-touch-icon.png b/docs/assets/apple-touch-icon.png deleted file mode 100644 index 22d0ae75..00000000 Binary files a/docs/assets/apple-touch-icon.png and /dev/null differ diff --git a/docs/assets/favicon-16x16.png b/docs/assets/favicon-16x16.png deleted file mode 100644 index dde459fc..00000000 Binary files a/docs/assets/favicon-16x16.png and /dev/null differ diff --git a/docs/assets/favicon-32x32.png b/docs/assets/favicon-32x32.png deleted file mode 100644 index 44228100..00000000 Binary files a/docs/assets/favicon-32x32.png and /dev/null differ diff --git a/docs/assets/logo.png b/docs/assets/logo.png new file mode 100644 index 00000000..7c860c3d Binary files /dev/null and b/docs/assets/logo.png differ diff --git a/docs/assets/site.webmanifest b/docs/assets/site.webmanifest deleted file mode 100644 index 45dc8a20..00000000 --- a/docs/assets/site.webmanifest +++ /dev/null @@ -1 +0,0 @@ -{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"} \ No newline at end of file diff --git a/docs/assets/stylesheets/circular.css b/docs/assets/stylesheets/circular.css deleted file mode 100644 index dddd9eaf..00000000 --- a/docs/assets/stylesheets/circular.css +++ /dev/null @@ -1,118 +0,0 @@ -@font-face { - font-family: Circular; - src: url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-light.woff2") - format("woff2"), - url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-light.woff") - format("woff"); - font-weight: 300; - font-style: normal; - } - @font-face { - font-family: Circular-hbr; - src: url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-light-hbr.woff2") - format("woff2"), - url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-light-hbr.woff") - format("woff"); - font-weight: 300; - font-style: normal; - } - @font-face { - font-family: Circular; - src: url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-book.woff2") - format("woff2"), - url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-book.woff") - format("woff"); - font-weight: 400; - font-style: normal; - } - @font-face { - font-family: Circular-hbr; - src: url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-book-hbr.woff2") - format("woff2"), - url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-book-hbr.woff") - format("woff"); - font-weight: 400; - font-style: normal; - } - @font-face { - font-family: Circular; - src: url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-medium.woff2") - format("woff2"), - url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-medium.woff") - format("woff"); - font-weight: 500; - font-style: normal; - } - @font-face { - font-family: Circular-hbr; - src: url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-medium-hbr.woff2") - format("woff2"), - url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-medium-hbr.woff") - format("woff"); - font-weight: 500; - font-style: normal; - } - @font-face { - font-family: Circular; - src: url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-bold.woff2") - format("woff2"), - url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-bold.woff") - format("woff"); - font-weight: 700; - font-style: normal; - } - @font-face { - font-family: Circular-hbr; - src: url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-bold-hbr.woff2") - format("woff2"), - url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-bold-hbr.woff") - format("woff"); - font-weight: 700; - font-style: normal; - } - @font-face { - font-family: Circular; - src: url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-black.woff2") - format("woff2"), - url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-black.woff") - format("woff"); - font-weight: 900; - font-style: normal; - } - @font-face { - font-family: Circular-hbr; - src: url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-black-hbr.woff2") - format("woff2"), - url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/circular-black-hbr.woff") - format("woff"); - font-weight: 900; - font-style: normal; - } - @font-face { - font-family: "noto-arabic"; - src: url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/notosansarabic-light.woff2") - format("woff2"), - url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/notosansarabic-light.woff") - format("woff"); - font-weight: 200; - font-style: normal; - } - @font-face { - font-family: "noto-arabic"; - src: url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/notosansarabic-regular.woff2") - format("woff2"), - url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/notosansarabic-regular.woff") - format("woff"); - font-weight: 400; - font-style: normal; - } - @font-face { - font-family: "noto-arabic"; - src: url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/notosansarabic-bold.woff2") - format("woff2"), - url("https://sp-bootstrap.global.ssl.fastly.net/8.11.0/fonts/notosansarabic-bold.woff") - format("woff"); - font-weight: 600; - font-style: normal; - } - \ No newline at end of file diff --git a/docs/mkdocs-requirements.txt b/docs/requirements.txt similarity index 88% rename from docs/mkdocs-requirements.txt rename to docs/requirements.txt index 70e92408..a74d1b6f 100644 --- a/docs/mkdocs-requirements.txt +++ b/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 deleted file mode 100644 index 7cb714d4..00000000 --- a/mkdocs-requirements.txt +++ /dev/null @@ -1,6 +0,0 @@ -flake8>=3.7.8 -mkdocs>=1.0.4 -mkdocs-material>=4.4.0 -mkdocs-click -pymdown-extensions>=7.1 --r ./mlcube/requirements.txt \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 30d4a9a5..e910c440 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,10 @@ -site_name: 'MLCube' -site_description: 'Documentation site for MLCube' -site_author: ' mlcommons@googlegroups.com' -docs_dir: 'docs/' +site_name: MLCube +site_description: Documentation site for MLCube +site_author: mlcommons@googlegroups.com +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