Cache avatars (mne-tools#12077)

drammock · web-flow · commit 812b02ef0808 · 2023-10-06T09:56:04.000Z
diff --git a/doc/_static/js/contrib-avatars.js b/doc/_static/js/contrib-avatars.js
@@ -47,7 +47,7 @@ async function putAvatarsInPage() {
     }
     // finish
     outer.append(title, inner);
-    document.getElementById("institution-logos").after(outer);
+    document.body.append(outer);
 }
 
 putAvatarsInPage();
diff --git a/doc/_templates/homepage.html b/doc/_templates/homepage.html
@@ -41,4 +41,6 @@
       </div>
     {% endfor %}
   </div>
+<!-- contributors -->
+{% include 'avatars.html' %}
 </div>
diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html
@@ -17,7 +17,4 @@
 {%- block scripts_end %}
     {{ super() }}
     <script src="https://mne.tools/versionwarning.js"></script>
-    {% if pagename == 'index' %}
-      <script src="{{ pathto('_static/js/contrib-avatars.js', 1) }}"></script>
-    {% endif %}
 {%- endblock %}
diff --git a/doc/conf.py b/doc/conf.py
@@ -103,6 +103,7 @@
     "sphinxcontrib.bibtex",
     "sphinxcontrib.youtube",
     # homegrown
+    "contrib_avatars",
     "gen_commands",
     "gen_names",
     "gh_substitutions",
diff --git a/doc/sphinxext/_avatar_template.html b/doc/sphinxext/_avatar_template.html
@@ -0,0 +1,7 @@
+<html>
+    <head>
+        <script src="../_static/js/contrib-avatars.js"></script>
+    </head>
+    <body>
+    </body>
+</html>
diff --git a/doc/sphinxext/contrib_avatars.py b/doc/sphinxext/contrib_avatars.py
@@ -0,0 +1,34 @@
+from pathlib import Path
+
+from selenium import webdriver
+from selenium.webdriver.common.by import By
+from selenium.webdriver.support.ui import WebDriverWait
+from selenium.common.exceptions import WebDriverException
+
+
+def generate_contrib_avatars(app, config):
+    """Render a template webpage with avatars generated by JS and a GitHub API call."""
+    root = Path(app.srcdir)
+    infile = root / "sphinxext" / "_avatar_template.html"
+    outfile = root / "_templates" / "avatars.html"
+    try:
+        options = webdriver.ChromeOptions()
+        options.add_argument("--headless=new")
+        driver = webdriver.Chrome(options=options)
+    except WebDriverException:
+        options = webdriver.FirefoxOptions()
+        options.add_argument("--headless=new")
+        driver = webdriver.Firefox(options=options)
+    driver.get(f"file://{infile}")
+    wait = WebDriverWait(driver, 20)
+    wait.until(lambda d: d.find_element(by=By.ID, value="contributor-avatars"))
+    body = driver.find_element(by=By.TAG_NAME, value="body").get_attribute("innerHTML")
+    with open(outfile, "w") as fid:
+        fid.write(body)
+    driver.quit()
+
+
+def setup(app):
+    """Set up the Sphinx app."""
+    app.connect("config-inited", generate_contrib_avatars)
+    return
diff --git a/requirements_doc.txt b/requirements_doc.txt
@@ -19,3 +19,4 @@ pytest
 graphviz
 pyzmq!=24.0.0
 ipython!=8.7.0
+selenium
diff --git a/tools/circleci_bash_env.sh b/tools/circleci_bash_env.sh
@@ -5,6 +5,8 @@ set -o pipefail
 
 ./tools/setup_xvfb.sh
 sudo apt install -qq graphviz optipng python3.10-venv python3-venv libxft2 ffmpeg
+wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
+sudo apt install ./google-chrome-stable_current_amd64.deb
 python3.10 -m venv ~/python_env
 echo "set -e" >> $BASH_ENV
 echo "set -o pipefail" >> $BASH_ENV

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ async function putAvatarsInPage() {`
`47`	`47`	`}`
`48`	`48`	`// finish`
`49`	`49`	`outer.append(title, inner);`
`50`		`- document.getElementById("institution-logos").after(outer);`
	`50`	`+ document.body.append(outer);`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`putAvatarsInPage();`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,7 @@ @@
 +<html>
 +    <head>
 +        <script src="../_static/js/contrib-avatars.js"></script>
 +    </head>
 +    <body>
 +    </body>
 +</html>