Adjust template for YSDA

1. Use Markdown instead of rst 2. Change branding
yandexdataschool · Aug 9, 2024 · be637d7 · be637d7
1 parent 9eeb4c9
commit be637d7
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 108 deletions.
diff --git a/content/01_Introduction/Introduction.md b/content/01_Introduction/Introduction.md
@@ -0,0 +1 @@
+## Введение
diff --git a/content/Figures/ysda_logo.png b/content/Figures/ysda_logo.png
diff --git a/content/Figures/ysda_logo_upscaled.png b/content/Figures/ysda_logo_upscaled.png
diff --git a/content/conf.py b/content/conf.py
@@ -17,10 +17,10 @@
 
 # -- Project information -----------------------------------------------------
 
-project = "LESSON NAME"
-copyright = "2020, The contributors"
-author = "The contributors"
-github_user = "coderefinery"
+project = "YSDA Course"
+copyright = "2024"
+author = "Authors"
+github_user = "yandexdataschool"
 github_repo_name = ""  # auto-detected from dirname if blank
 github_version = "main"
 conf_py_path = "/content/"  # with leading and trailing slash
@@ -38,12 +38,17 @@
     "sphinx_rtd_theme_ext_color_contrast",
 ]
 
+myst_enable_extensions = [
+    "colon_fence",   # ::: can be used instead of ``` for better rendering
+    ]
+
 # Settings for myst_nb:
-# https://myst-nb.readthedocs.io/en/latest/use/execute.html#triggering-notebook-execution
-# 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"
+# https://myst-nb.readthedocs.io/en/latest/computation/execute.html#notebook-execution-modes
+# nb_execution_mode = "off"
+# nb_execution_mode = "auto"   # *only* execute if at least one output is missing.
+# nb_execution_mode = "force"
+# nb_execution_mode = "cache"
+nb_execution_mode = "cache"
 
 # Add any paths that contain templates here, relative to this directory.
 # templates_path = ['_templates']
@@ -67,6 +72,7 @@
 # a list of builtin themes.
 #
 html_theme = "sphinx_rtd_theme"
+html_logo = "Figures/ysda_logo_upscaled.png"
 
 # 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,

diff --git a/content/guide.rst b/content/guide.rst
diff --git a/content/index.md b/content/index.md
@@ -0,0 +1,16 @@
+# Название курса
+
+## Краткое описание
+
+## Программа
+
+## Критерии оценивания
+
+## Полезные ссылки
+
+```{toctree}
+:maxdepth: 1
+:caption: Лекции
+
+01_Introduction/Introduction
+```
diff --git a/content/index.rst b/content/index.rst
diff --git a/content/quick-reference.rst b/content/quick-reference.rst