Add videos to documentation (#481)

.gitignore

@@ -73,9 +73,9 @@ instance/
 docs/_build/
 docs/build/
 docs/source/_build/
-docs/source/getting_started/*.db
-docs/source/getting_started/*.db-shm
-docs/source/getting_started/*.db-wal
+docs/source/**/*.db
+docs/source/**/*.db-shm
+docs/source/**/*.db-wal
 docs/source/refs.bib.bak
 
 # PyBuilder

docs/source/conf.py

@@ -47,7 +47,6 @@
     "myst_nb",
     "sphinxcontrib.bibtex",
     "sphinx_panels",
-    "sphinx_copybutton",
 ]
 
 myst_enable_extensions = [

docs/source/development/eep-00-governance-model.md

@@ -9,7 +9,7 @@
 |            | `Hans-Martin von Gaudecker <https://github.com/hmgaudecker>`_,   |
 |            | `Annica Gehlen <https://github.com/amageh>`_,                    |
 |            | `Sebastian Gsell <https://github.com/segsell>`_,                 |
-|            | `Tim Mensinger <https://github.com/timmens>_,                    |
+|            | `Tim Mensinger <https://github.com/timmens>`_,                   |
 |            | `Mariam Petrosyan <https://github.com/mpetrosian>`_,             |
 |            | `Tobias Raabe <https://github.com/tobiasraabe>`_,                |
 |            | `Klara Röhrl <https://github.com/roecla>`_                       |

docs/source/getting_started/index.md

@@ -67,6 +67,21 @@ reference for more experienced users.
                 </div>
             </a>
         </div>
+        <div class="col-lg-12 col-md-12 col-sm-12 col-xs-12">
+            <a href="../videos.html" id="index-link">
+                <div class="card text-center intro-card shadow" style="width: 100%;">
+                    <img src="../_static/images/video.svg" class="card-img-top"
+                         alt="video icon" height="60"
+                    >
+                    <div class="card-body flex-fill">
+                        <h5 class="card-title">Videos</h5>
+                        <p class="card-text">
+                            Collection of tutorials, talks, and screencasts on estimagic.
+                        </p>
+                    </div>
+                </div>
+            </a>
+        </div>
     </div>
 </div>
 ```

docs/source/how_to_guides/index.md

@@ -67,6 +67,21 @@ an introduction to its basic functionality, check out our tutorials.
                 </div>
             </a>
         </div>
+        <div class="col-lg-12 col-md-12 col-sm-12 col-xs-12">
+            <a href="../videos.html" id="index-link">
+                <div class="card text-center intro-card shadow" style="width: 100%;">
+                    <img src="../_static/images/video.svg" class="card-img-top"
+                         alt="video icon" height="60"
+                    >
+                    <div class="card-body flex-fill">
+                        <h5 class="card-title">Videos</h5>
+                        <p class="card-text">
+                            Collection of tutorials, talks, and screencasts on estimagic.
+                        </p>
+                    </div>
+                </div>
+            </a>
+        </div>
     </div>
 </div>
 ```

docs/source/index.md

@@ -109,6 +109,21 @@ For a complete introduction to optimization in estimagic, check out the
                 </div>
             </a>
         </div>
+        <div class="col-lg-12 col-md-12 col-sm-12 col-xs-12">
+            <a href="videos.html" id="index-link">
+                <div class="card text-center intro-card shadow" style="width: 100%;">
+                    <img src="_static/images/video.svg" class="card-img-top"
+                         alt="video icon" height="60"
+                    >
+                    <div class="card-body flex-fill">
+                        <h5 class="card-title">Videos</h5>
+                        <p class="card-text">
+                            Collection of tutorials, talks, and screencasts on estimagic.
+                        </p>
+                    </div>
+                </div>
+            </a>
+        </div>
     </div>
 </div>
 ```
@@ -122,6 +137,9 @@ getting_started/index
 how_to_guides/index
 explanations/index
 reference_guides/index
+development/index
+videos
+algorithms
 ```
 
 ## Highlights
@@ -163,15 +181,6 @@ reference_guides/index
 
 **Useful links for search:** {ref}`genindex` | {ref}`modindex` | {ref}`search`
 
-```{toctree}
----
-hidden: true
-maxdepth: 1
----
-development/index
-algorithms
-```
-
 [how to do multistart]: how_to_guides/optimization/how_to_do_multistart_optimizations
 [how to use logging]: how_to_guides/optimization/how_to_use_logging
 [msm tutorial]: getting_started/estimation/first_msm_estimation_with_estimagic

docs/source/videos.md

@@ -0,0 +1,87 @@
+(list_of_videos)=
+
+# Videos
+
+Check out our tutorials, talks and screencasts about estimagic.
+
+## Talks and tutorials
+
+### EuroSciPy 2023 (Talk)
+
+```{raw} html
+<iframe
+src="https://www.youtube.com/embed/5xYn0v1zEsY"
+style="width: 100%; aspect-ratio: 16 / 9;"
+allowfullscreen>
+</iframe>
+```
+
+### EuroSciPy 2023 (Tutorial)
+
+```{raw} html
+<iframe
+src="https://www.youtube.com/embed/LQo5NDFKH1Q"
+style="width: 100%; aspect-ratio: 16 / 9;"
+allowfullscreen>
+</iframe>
+```
+
+### SciPy 2022 (Tutorial)
+
+```{raw} html
+<iframe
+src="https://www.youtube.com/embed/ftlw0rARrtI"
+style="width: 100%; aspect-ratio: 16 / 9;"
+allowfullscreen>
+</iframe>
+```
+
+## Screencasts
+
+The screencasts are part of the course _Effective Programming Practices for Economists_,
+taught at the University of Bonn by
+[Hans-Martin von Gaudecker](https://www.wiwi.uni-bonn.de/gaudecker/), and previously
+also [Janoś Gabler](https://github.com/janosg). You can find all screencasts of the
+course on the
+[course webite](https://effective-programming-practices.vercel.app/landing-page.html).
+Here, we show the screencasts about numerical optimization and estimagic.
+
+### Introduction to numerical optimization
+
+```{raw} html
+<iframe
+src="https://www.youtube.com/embed/hOZueB4Cn1Y"
+style="width: 100%; aspect-ratio: 16 / 9;"
+allowfullscreen>
+</iframe>
+```
+
+### Using estimagic’s minimize and maximize
+
+```{raw} html
+<iframe
+src="https://www.youtube.com/embed/QqTGE3nq0q8"
+style="width: 100%; aspect-ratio: 16 / 9;"
+allowfullscreen>
+</iframe>
+```
+
+### Visualizing optimizer histories
+
+```{raw} html
+<iframe
+src="https://www.youtube.com/embed/wQWWW8rlxmY"
+style="width: 100%; aspect-ratio: 16 / 9;"
+allowfullscreen>
+</iframe>
+```
+
+### Choosing optimization algorithms
+
+```{raw} html
+<iframe
+src="https://www.youtube.com/embed/tJ7Xba3wcxY"
+style="width: 100%; aspect-ratio: 16 / 9;"
+allowfullscreen>
+</iframe>
+```