Merge pull request #1 from kir-rescomp/dev

update readme

Author: DininduSenanayake

.github/workflows/ci.yml

@@ -0,0 +1,18 @@
+name: ci 
+
+
+on:
+  push:
+    branches:
+      - main
+      
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: pip install -r requirements.txt 
+      - run: mkdocs gh-deploy --force

README.md

@@ -1 +1,7 @@
-# training-gpu-profiling
+# GPU profiling
+
+Material : https://kir-rescomp.github.io/training-gpu-profiling/
+
+<p align="center">
+    <img src="./docs/images/gpu_profiling.png" width="300">
+</p>

docs/images/kir_oxford_combined_logo.png

@@ -1 +1,124 @@
-site_name: My Docs
+site_name: GPU Profiling
+site_author: The Kennedy Institute of Rheumatology, NDORMS, University of Oxford
+site_dir: public
+site_url: "https://kir-rescomp.github.io/training-gpu-profiling/"
+
+#Repository information
+repo_name:  kir-rescomp/training-gpu-profiling
+repo_url: https://github.com/kir-rescomp/training-gpu-profiling
+
+
+theme:
+  name: material
+  logo: images/kir_oxford_combined_logo.png
+  favicon: images/kir_standalone_logo.png 
+   # 404 page
+  static_templates:
+    - 404.html
+
+  palette:
+
+  # Palette toggle for automatic mode
+  - media: "(prefers-color-scheme)"
+    toggle:
+      icon: material/brightness-auto
+      name: Switch to light mode
+    primary: custom
+
+  # Palette toggle for light mode
+  - media: "(prefers-color-scheme: light)"
+    scheme: default
+    primary: custom
+
+
+    toggle:
+      icon: material/brightness-7
+      name: Switch to dark mode
+
+  # Palette toggle for dark mode
+  - media: "(prefers-color-scheme: dark)"
+    scheme: slate
+    toggle:
+      icon: material/brightness-4
+      name: Switch to system preference
+    primary: custom
+  
+  features:
+    - navigation.tracking
+    - navigation.sections
+    - navigation.expand
+    - navigation.top
+    - navigation.footer
+    - content.code.copy
+    - content.code.annotate
+
+
+  # Necessary for search to work properly
+  include_search_page: false
+  search_index_only: true
+
+  # Default values, taken from mkdocs_theme.yml
+  language: en
+  font:
+    text: Mukta
+    code: Fira Code
+
+markdown_extensions:
+  - abbr
+  - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - meta
+  - md_in_html
+  - toc:
+      permalink: true
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.magiclink:
+      repo_url_shorthand: true
+      user: squidfunk
+      repo: mkdocs-material
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+  - pymdownx.snippets
+  - pymdownx.blocks.caption
+
+plugins: 
+  - glightbox:
+      effect: zoom
+      zoomable: true
+  - search:
+      lang: en
+
+extra_javascript:
+  - javascripts/mathjax.js
+  - https://polyfill.io/v3/polyfill.min.js?features=es6
+  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
+
+copyright : KIR Training Catalogue is licensed under a <a rel="noopener" target="_blank" href="https://www.gnu.org/licenses/gpl-3.0.en.html">GNU General Public License v3.0</a>
+
+
+extra_css:
+  - stylesheets/extra.css