add auto footer with license and citation

Author: OriolAbril

_templates/page.html

@@ -6,4 +6,20 @@
 {% endif %}
 
   {{ body }}
+
+<!-- continuation of examples/page_footer.md -->
+{% if pagename in ablog %}
+  <ul>
+    <li>
+      {% for coll in post.author %}
+        {% if coll|length %}
+          {{ coll }}
+          {% if loop.index < post.author|length %},{% endif %}
+        {% else %}
+          {{ coll }}
+          {% if loop.index < post.author|length %},{% endif %}
+        {% endif %}
+      {% endfor %}. "{{ title.split(' — ')[0] }}". In: <i>PyMC Examples</i>. DOI: <a href={{ doi_url }}>{{ doi_code }}</a></li>
+  </ul>
+{% endif %}
 {% endblock %}

_templates/postcard.html

@@ -4,16 +4,6 @@
   <h3>Notebook metadata</h3>
 
   <ul>
-  {% if post.author %}
-    <li id="author">
-      <span><i class="fa-fw fa fa-user"></i></span>
-      <a href="#authors">{% for coll in post.author %} {% if coll|length %}
-      {{ coll }}{% if loop.index <
-      post.author|length %},{% endif %} {% else %}{{ coll }}{% if loop.index <
-      post.author|length %},{% endif %}{% endif %} {% endfor %}
-      </a>
-    </li>
-  {% endif %}
   {% if post.category %}
     <li id="category">
     <span><i class="fa-fw fa fa-folder-open"></i></span>

examples/conf.py

@@ -1,12 +1,10 @@
 import os
 
-
 # -- Project information -----------------------------------------------------
 project = "PyMC"
 copyright = "2021, PyMC Community"
 author = "PyMC Community"
 
-
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
@@ -110,7 +108,7 @@
 # post_auto_excerpt = 2
 
 # MyST config
-myst_enable_extensions = ["colon_fence", "deflist", "dollarmath", "amsmath"]
+myst_enable_extensions = ["colon_fence", "deflist", "dollarmath", "amsmath", "substitution"]
 jupyter_execute_notebooks = "off"
 
 # bibtex config
@@ -136,10 +134,10 @@ def ipython_cell_transform(source):
     "ipython3": ipython_cell_transform,
 }
 codeautolink_autodoc_inject = False
-codeautolink_global_preface = """
-import arviz as az
-import pymc3 as pm
-"""
+# codeautolink_global_preface = """
+# import arviz as az
+# import pymc3 as pm
+# """
 
 # intersphinx mappings
 intersphinx_mapping = {

examples/getting_started.ipynb

@@ -3821,6 +3821,14 @@
     "%load_ext watermark\n",
     "%watermark -n -u -v -iv -w"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    ":::{include} page_footer.md\n",
+    ":::"
+   ]
   }
  ],
  "metadata": {

examples/page_footer.md

@@ -0,0 +1,26 @@
+## License notice
+All the notebooks in this example gallery are provided under the
+[MIT License](https://github.com/pymc-devs/pymc-examples/blob/main/LICENSE)
+which allows modification, and redistribution for any
+use provided the copyright and license notices are preserved.
+
+## Citing PyMC examples
+
+To cite this notebook, use the DOI provided by Zenodo for the pymc-examples repository.
+Here is an citation template in bibtex:
+
+```bibtex
+@incollection{citekey,
+  author    = "<notebook authors, see above>"
+  title     = "<notebook title>",
+  booktitle = "PyMC examples",
+  doi       = "<doi_code>"
+}
+```
+
+which once rendered could look like:
+
+<!-- continues in _templates/page.html!!! -->
+<!-- I wanted to get some kind of automatation to the process,
+and html templates have access to many variables that are not available
+from jinja-myst -->

examples/splines/spline.ipynb

@@ -1531,6 +1531,21 @@
     "%load_ext watermark\n",
     "%watermark -n -u -v -iv -w -p theano,xarray,patsy"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    ":::{include} ../page_footer.md\n",
+    ":::"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {
@@ -1549,7 +1564,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.6"
+   "version": "3.9.7"
   }
  },
  "nbformat": 4,