adding kernel links, displaying documentation urls, tooltips

data/hooks.py

@@ -6,7 +6,7 @@ def generate_cards(*args, **kwargs):
 
     # get all data
     data_dir = "data"
-    exclude = ["template.yaml","hooks.py","cardinfo.yaml"]
+    exclude = ["template.yaml","hooks.py","cardinfo.yaml", "kernels_and_extensions.yaml"]
     files = glob.glob(os.path.join(data_dir, "*.yaml"))
     services_names = [os.path.splitext(os.path.basename(file_name))[0] for file_name in files]
 

data/kernels_and_extensions.yaml

@@ -0,0 +1,22 @@
+Links:
+  ansible: https://github.com/ansible/ansible-jupyter-kernel
+  bash: https://github.com/takluyver/bash_kernel
+  c++: https://github.com/jupyter-xeus/xeus-cling
+  cling: https://github.com/jupyter-xeus/xeus-cling
+  golang: https://github.com/gopherdata/gophernotes
+  gurobi: https://www.gurobi.com/documentation/
+  gnuplot: https://github.com/has2k1/gnuplot_kernel
+  javaScript: https://github.com/n-riesco/ijavascript
+  julia: https://github.com/JuliaLang/IJulia.jl
+  matlab 2020b: https://www.mathworks.com/content/dam/mathworks/mathworks-dot-com/support/sysreq/files/system-requirements-release-2020b-linux.pdf
+  matlab 2022b: https://www.mathworks.com/content/dam/mathworks/mathworks-dot-com/support/sysreq/files/system-requirements-release-2022b-windows.pdf
+  mathmatica: https://github.com/mmatera/iwolfram
+  octave: https://github.com/Calysto/octave_kernel
+  python: https://ipython.org/
+  r: https://github.com/IRkernel/IRkernel
+  ruby: https://github.com/SciRuby/iruby
+  sage: https://www.sagemath.org/
+  scheme: https://github.com/Calysto/calysto_scheme
+  rust: https://crates.io/crates/evcxr_jupyter
+  c++: https://github.com/AnthonyCalandra/modern-cpp-features
+  matlab: https://github.com/mathworks/jupyter-matlab-proxy

docs/gen_detail_pages.py

@@ -5,7 +5,7 @@
 
 # get all data
 data_dir = "data"
-exclude = ["template.yaml", "hooks.py", "cardinfo.yaml"]
+exclude = ["template.yaml", "hooks.py", "cardinfo.yaml", "kernels_and_extensions.yaml"]
 files = glob.glob(os.path.join(data_dir, "*.yaml"))
 services_names = [os.path.splitext(os.path.basename(file_name))[0] for file_name in files]
 

include/details.md

@@ -1,3 +1,4 @@
+icon: fontawesome/solid/info
 # {{ title }}
 The {{ title }} can be reached [here]({{ service_url }}) and is provided by {{ provider }}.
 
@@ -12,18 +13,19 @@ __Target group__
 
 __Login process__
 
-: {{ login_process }}
+: {{ login_process }} 
 
 __Support__
 
 : {{ support|urlize }}
 
 __Documentation__
 
-: {{ documentation_url }}
+: {% if documentation_url %}[{{ documentation_url }}]({{ documentation_url }}){% else %}None{% endif %}
 
 
-## Features
+
+## Features 
 {{ title }} offers:
 
 === "General"
@@ -42,18 +44,24 @@ __Documentation__
     - {{ feature }}
     {% endfor %}
 
-{% if (features.programming_languages or features.environments) %}
-=== "Kernels"
+{% if (features.programming_languages or features.environments) %} 
+=== "Kernels :material-information-outline:{ title="Links to Kernels" }" 
     {% if features.programming_languages %}
     Programming Languages:
     {% for kernel in features.programming_languages %}
+    {% if Links[kernel | lower] %}
+    - [{{ kernel }}]({{ Links[kernel | lower] }})
+    {% else %}
     - {{ kernel }}
-    {% endfor %}
     {% endif %}
-    {% if features.environments %}
+    {% endfor %}
+{% endif %}
+    {% if features.environments %} 
     Environments:
     {% for kernel in features.environments %}
-    - {{ kernel }}
+-   {{ kernel }} {% if Links[kernel] %} [{{ Links[kernel] }}]({{ Links[kernel] }}) 
+    {% else %}  
+    {% endif %}
     {% endfor %}
     {% endif %}
 {% endif %}
@@ -86,7 +94,7 @@ __Documentation__
 | Persistent disk space              | {{ resources.default_persistent_disk }} | {{ resources.max_persistent_disk }} |
 
 {% if technicals %}
-## Technicals
+## Technical
 Some technical insights about {{ title }}:
   {% if technicals.platform %}
 - Platform: {{ technicals.platform }}

mkdocs.yml

@@ -13,13 +13,15 @@ theme:
   logo: assets/nfdi_rgb_Wortmarke_Zusatz_hoch.png
   favicon: assets/nfdi_rgb_Wortmarke.png
   language: en
-  #features:
+  features:
+    - content.tooltips
   #  - navigation.tabs
   custom_dir: custom/
 
 extra_css:
   - css/neoteroi-cards.css
   - css/extra.css
+  - css/hint.min.css
 
 extra_javascript:
   - https://unpkg.com/[email protected]/dist/tablesort.min.js
@@ -38,14 +40,20 @@ markdown_extensions:
   - tables
   - def_list
   - neoteroi.cards
+  - abbr
+  - attr_list
+  - pymdownx.snippets
 
 plugins:
   - search
+  - tooltips
   - gen-files:
       scripts:
         - docs/gen_detail_pages.py
   - macros:
       include_dir: include
+      include_yaml:
+        - data/kernels_and_extensions.yml
   - mkdocs-simple-hooks:
       hooks:
         on_pre_build: "data.hooks:generate_cards"