Sync with sphinx-lesson-template

Author: ashwinvis

LICENSE.code

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022, HPDA-Python and individual contributors.
+Copyright (c) 2024, ENCCS and individual contributors.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-

content/_static/overrides.css

@@ -26,7 +26,7 @@
     background: #DDDDDD;
 }
 .rst-content .instructor-note > .admonition-title {
-    background: #BBBBBB;
+    background: #595959;
 }
 .rst-content .instructor-note > .admonition-title::before {
     content: "";
@@ -37,31 +37,31 @@
     background: #EEEEBB;
 }
 .rst-content .callout > .admonition-title {
-    background: #BBCC33;
+    background: #595959;
 }
 
 /* questions */
 .rst-content .questions {
     background: rgba(253, 219, 199, 0.3);
 }
 .rst-content .questions > .admonition-title {
-    background: rgba(204, 51, 17, 0.5);
+    background: #993360;
 }
 
 /* discussion */
 .rst-content .discussion {
-    background: rgba(231, 212, 232 0.3);
+    background: rgba(231, 212, 232, 0.3);
 }
 .rst-content .discussion > .admonition-title {
-    background: rgba(194, 165, 207, 0.5);
+    background: #714884;
 }
 
 /* signature */
 .rst-content .signature {
     background: rgba(217, 240, 211, 0.3);
 }
 .rst-content .signature > .admonition-title {
-    background: rgba(172, 211, 158, 0.5);
+    background: #21634b;
 }
 .rst-content .signature > .admonition-title::before {
     content: "\01F527";
@@ -72,7 +72,7 @@
     background: rgba(217, 240, 211, 0.0);
 }
 .rst-content .parameters > .admonition-title {
-    background: rgba(172, 211, 158, 0.5);
+    background: #21634b;
 }
 .rst-content .parameters > .admonition-title::before {
     content: "\01F4BB";
@@ -83,7 +83,7 @@
     background: rgba(221, 221, 221, 0.3);
 }
 .rst-content .typealong > .admonition-title {
-    background: rgba(187, 187, 187, 1.0);
+    background: rgba(89, 89, 89, 1.0);
 }
 .rst-content .typealong > .admonition-title::before {
     content: "\02328";

content/conf.py

@@ -21,7 +21,7 @@
 copyright = "2022, ENCCS and individual contributors."
 author = "ENCCS and individual contributors."
 github_user = "ENCCS"
-github_repo_name = "HPDA-Python"
+github_repo_name = ""  # auto-detected from dirname if blank
 github_version = "main"
 conf_py_path = "/content/"  # with leading and trailing slash
 
@@ -44,7 +44,15 @@
 # jupyter_execute_notebooks = "off"
 # jupyter_execute_notebooks = "auto"   # *only* execute if at least one output is missing.
 # jupyter_execute_notebooks = "force"
-jupyter_execute_notebooks = "cache"
+nb_execution_mode = "cache"
+
+# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
+myst_enable_extensions = [
+    "colon_fence",
+]
+
+# Settings for sphinx-copybutton
+copybutton_exclude = ".linenos, .gp"
 
 # Add any paths that contain templates here, relative to this directory.
 # templates_path = ['_templates']
@@ -73,7 +81,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 html_css_files = ["overrides.css"]
 
 # HTML context:
@@ -84,7 +92,7 @@
     "github_user": github_user,
     # Auto-detect directory name.  This can break, but
     # useful as a default.
-    "github_repo": github_repo_name or basename(dirname(realpath(__file__))),
+    "github_repo": github_repo_name or basename(dirname(dirname(realpath(__file__)))),
     "github_version": github_version,
     "conf_py_path": conf_py_path,
 }
@@ -120,17 +128,27 @@ class TypealongDirective(_BaseCRDirective):
     extra_classes = ["toggle-shown", "dropdown"]
 
 
-DIRECTIVES = [SignatureDirective, ParametersDirective, TypealongDirective]
+DIRECTIVES: list[type[_BaseCRDirective]] = [
+    SignatureDirective,
+    ParametersDirective,
+    TypealongDirective,
+]
 
 
 def setup(app):
     for obj in DIRECTIVES:
-        app.add_directive(obj.get_cssname(), obj)
+        app.add_directive(obj.cssname(), obj)
+
 
 import os
-if os.environ.get('GITHUB_REF', '') == 'refs/heads/main':
+
+if os.environ.get("GITHUB_REF", "") == "refs/heads/main":
     html_js_files = [
-        ('https://plausible.io/js/script.js', {"data-domain": "enccs.github.io/hpda-python", "defer": "\
-defer"}),
+        (
+            "https://plausible.io/js/script.js",
+            {
+                "data-domain": "enccs.github.io/hpda-python",
+                "defer": "defer",
+            },
+        ),
     ]
-