Merge pull request #63 from glotzerlab/mdbook-4-43

Support mdbook 0.4.43
glotzerlab · Dec 4, 2024 · a126254 · a126254
2 parents 3aded8e + 4c7bee5
commit a126254
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 59 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -3,7 +3,7 @@ build:
   os: "ubuntu-22.04"
   commands:
     - mkdir -p bin
-    - curl -sSL "https://github.com/rust-lang/mdBook/releases/download/v0.4.40/mdbook-v0.4.40-x86_64-unknown-linux-gnu.tar.gz" | tar -xvz --directory "bin"
+    - curl -sSL "https://github.com/rust-lang/mdBook/releases/download/v0.4.43/mdbook-v0.4.43-x86_64-unknown-linux-gnu.tar.gz" | tar -xvz --directory "bin"
     - mkdir -p $READTHEDOCS_OUTPUT/html
     - echo "site-url = \"/$READTHEDOCS_LANGUAGE/$READTHEDOCS_VERSION/\"" >> doc/book.toml
     - bin/mdbook build doc --dest-dir=$READTHEDOCS_OUTPUT/html
diff --git a/doc/src/release-notes.md b/doc/src/release-notes.md
@@ -18,6 +18,7 @@
 * All user-provided content (directories, action names, cluster names, and values) are
   properly escaped in the bash script output.
 * Typographical errors in the documentation.
+* The documentation now builds correctly with mdbook 0.4.43.
 
 ## 0.3.1 (2024-10-04)
 

diff --git a/doc/theme/index.hbs b/doc/theme/index.hbs
@@ -1,5 +1,5 @@
 <!DOCTYPE HTML>
-<html lang="{{ language }}" class="{{ default_theme }}" dir="{{ text_direction }}">
+<html lang="{{ language }}" class="{{ default_theme }} sidebar-visible" dir="{{ text_direction }}">
     <head>
         <!-- Book generated using mdBook -->
         <meta charset="UTF-8">
@@ -52,15 +52,17 @@
         <!-- MathJax -->
         <script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
         {{/if}}
-    </head>
-    <body class="sidebar-visible no-js">
-    <div id="body-container">
+
         <!-- Provide site root to javascript -->
         <script>
             var path_to_root = "{{ path_to_root }}";
             var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "{{ preferred_dark_theme }}" : "{{ default_theme }}";
         </script>
-
+        <!-- Start loading toc.js asap -->
+        <script src="{{ path_to_root }}toc.js"></script>
+    </head>
+    <body>
+    <div id="body-container">
         <!-- Work around some values being stored in localStorage wrapped in quotes -->
         <script>
             try {
@@ -82,19 +84,16 @@
             var theme;
             try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
             if (theme === null || theme === undefined) { theme = default_theme; }
-            var html = document.querySelector('html');
+            const html = document.documentElement;
             html.classList.remove('{{ default_theme }}')
             html.classList.add(theme);
-            var body = document.querySelector('body');
-            body.classList.remove('no-js')
-            body.classList.add('js');
+            html.classList.add("js");
         </script>
 
         <input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
 
         <!-- Hide / unhide sidebar before it is displayed -->
         <script>
-            var body = document.querySelector('body');
             var sidebar = null;
             var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
             if (document.body.clientWidth >= 1080) {
@@ -104,49 +103,21 @@
                 sidebar = 'hidden';
             }
             sidebar_toggle.checked = sidebar === 'visible';
-            body.classList.remove('sidebar-visible');
-            body.classList.add("sidebar-" + sidebar);
+            html.classList.remove('sidebar-visible');
+            html.classList.add("sidebar-" + sidebar);
         </script>
 
         <nav id="sidebar" class="sidebar" aria-label="Table of contents">
-            <div class="sidebar-scrollbox">
-                {{#toc}}{{/toc}}
-                <div
-                  id="mdbook-ad-placement"
-                  class="flat"
-                  data-ea-publisher="readthedocs"
-                  data-ea-type="readthedocs-sidebar"
-                  data-ea-manual="true"
-                  style="width: 70%; margin: 0 auto;"
-                ></div>
-            </div>
+            <!-- populated by js -->
+            <mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
+            <noscript>
+                <iframe class="sidebar-iframe-outer" src="{{ path_to_root }}toc.html"></iframe>
+            </noscript>
             <div id="sidebar-resize-handle" class="sidebar-resize-handle">
                 <div class="sidebar-resize-indicator"></div>
             </div>
         </nav>
 
-        <!-- Track and set sidebar scroll position -->
-        <script>
-            var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
-            sidebarScrollbox.addEventListener('click', function(e) {
-                if (e.target.tagName === 'A') {
-                    sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
-                }
-            }, { passive: true });
-            var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
-            sessionStorage.removeItem('sidebar-scroll');
-            if (sidebarScrollTop) {
-                // preserve sidebar scroll position when navigating via links within sidebar
-                sidebarScrollbox.scrollTop = sidebarScrollTop;
-            } else {
-                // scroll sidebar to current active section when navigating via "next/previous chapter" buttons
-                var activeSection = document.querySelector('#sidebar .active');
-                if (activeSection) {
-                    activeSection.scrollIntoView({ block: 'center' });
-                }
-            }
-        </script>
-
         <div id="page-wrapper" class="page-wrapper">
 
             <div class="page">
@@ -222,19 +193,19 @@
                     <main>
                         {{{ content }}}
 
-						<!-- Page footer -->
-						<hr>
-						<div class="left" style="width: 75%">
-					    <p>Development of <b>row</b> is led by the <a href="https://glotzerlab.engin.umich.edu">Glotzer Group</a> at the <a href="https://umich.edu">University of Michigan</a>.
-						<p>Copyright &#169; 2024 The Regents of the University of Michigan.
-						</div>
-						<div class="right">
-						<a href="https://umich.edu">
-						<img class="right" src="{{ path_to_root }}images/umich-block-M.svg" alt="University of Michigan logo" style="width: 84px" />
-						</a>
-						</div>
-						<div style="clear:both" />
-					</main>
+                        <!-- Page footer -->
+                        <hr>
+                        <div class="left" style="width: 75%">
+                        <p>Development of <b>row</b> is led by the <a href="https://glotzerlab.engin.umich.edu">Glotzer Group</a> at the <a href="https://umich.edu">University of Michigan</a>.
+                        <p>Copyright &#169; 2024 The Regents of the University of Michigan.
+                        </div>
+                        <div class="right">
+                        <a href="https://umich.edu">
+                        <img class="right" src="{{ path_to_root }}images/umich-block-M.svg" alt="University of Michigan logo" style="width: 84px" />
+                        </a>
+                        </div>
+                        <div style="clear:both" />
+                    </main>
 
                     <nav class="nav-wrapper" aria-label="Page navigation">
                         <!-- Mobile navigation buttons -->