Skip to content
Snippets Groups Projects
documenter.js 30.1 KiB
Newer Older
  • Learn to ignore specific revisions
  • Documenter.jl's avatar
    Documenter.jl committed
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
    // Generated by Documenter.jl
    requirejs.config({
      paths: {
        'highlight-julia': 'https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/languages/julia.min',
        'headroom': 'https://cdnjs.cloudflare.com/ajax/libs/headroom/0.12.0/headroom.min',
        'jqueryui': 'https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.13.2/jquery-ui.min',
        'katex-auto-render': 'https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/contrib/auto-render.min',
        'jquery': 'https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.0/jquery.min',
        'headroom-jquery': 'https://cdnjs.cloudflare.com/ajax/libs/headroom/0.12.0/jQuery.headroom.min',
        'katex': 'https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min',
        'highlight': 'https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min',
        'highlight-julia-repl': 'https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/languages/julia-repl.min',
      },
      shim: {
      "highlight-julia": {
        "deps": [
          "highlight"
        ]
      },
      "katex-auto-render": {
        "deps": [
          "katex"
        ]
      },
      "headroom-jquery": {
        "deps": [
          "jquery",
          "headroom"
        ]
      },
      "highlight-julia-repl": {
        "deps": [
          "highlight"
        ]
      }
    }
    });
    ////////////////////////////////////////////////////////////////////////////////
    require(['jquery', 'katex', 'katex-auto-render'], function($, katex, renderMathInElement) {
    $(document).ready(function() {
      renderMathInElement(
        document.body,
        {
      "delimiters": [
        {
          "left": "$",
          "right": "$",
          "display": false
        },
        {
          "left": "$$",
          "right": "$$",
          "display": true
        },
        {
          "left": "\\[",
          "right": "\\]",
          "display": true
        }
      ]
    }
    
      );
    })
    
    })
    ////////////////////////////////////////////////////////////////////////////////
    require(['jquery', 'highlight', 'highlight-julia', 'highlight-julia-repl'], function($) {
    $(document).ready(function() {
        hljs.highlightAll();
    })
    
    })
    ////////////////////////////////////////////////////////////////////////////////
    require(['jquery'], function($) {
    
    let timer = 0;
    var isExpanded = true;
    
    $(document).on(
      "click",
      ".docstring .docstring-article-toggle-button",
      function () {
        let articleToggleTitle = "Expand docstring";
        const parent = $(this).parent();
    
        debounce(() => {
          if (parent.siblings("section").is(":visible")) {
            parent
              .find("a.docstring-article-toggle-button")
              .removeClass("fa-chevron-down")
              .addClass("fa-chevron-right");
          } else {
            parent
              .find("a.docstring-article-toggle-button")
              .removeClass("fa-chevron-right")
              .addClass("fa-chevron-down");
    
            articleToggleTitle = "Collapse docstring";
          }
    
          parent
            .children(".docstring-article-toggle-button")
            .prop("title", articleToggleTitle);
          parent.siblings("section").slideToggle();
        });
      }
    );
    
    $(document).on("click", ".docs-article-toggle-button", function (event) {
      let articleToggleTitle = "Expand docstring";
      let navArticleToggleTitle = "Expand all docstrings";
      let animationSpeed = event.noToggleAnimation ? 0 : 400;
    
      debounce(() => {
        if (isExpanded) {
          $(this).removeClass("fa-chevron-up").addClass("fa-chevron-down");
          $("a.docstring-article-toggle-button")
            .removeClass("fa-chevron-down")
            .addClass("fa-chevron-right");
    
          isExpanded = false;
    
          $(".docstring section").slideUp(animationSpeed);
        } else {
          $(this).removeClass("fa-chevron-down").addClass("fa-chevron-up");
          $("a.docstring-article-toggle-button")
            .removeClass("fa-chevron-right")
            .addClass("fa-chevron-down");
    
          isExpanded = true;
          articleToggleTitle = "Collapse docstring";
          navArticleToggleTitle = "Collapse all docstrings";
    
          $(".docstring section").slideDown(animationSpeed);
        }
    
        $(this).prop("title", navArticleToggleTitle);
        $(".docstring-article-toggle-button").prop("title", articleToggleTitle);
      });
    });
    
    function debounce(callback, timeout = 300) {
      if (Date.now() - timer > timeout) {
        callback();
      }
    
      clearTimeout(timer);
    
      timer = Date.now();
    }
    
    })
    ////////////////////////////////////////////////////////////////////////////////
    require([], function() {
    function addCopyButtonCallbacks() {
      for (const el of document.getElementsByTagName("pre")) {
        const button = document.createElement("button");
        button.classList.add("copy-button", "fa-solid", "fa-copy");
        button.setAttribute("aria-label", "Copy this code block");
        button.setAttribute("title", "Copy");
    
        el.appendChild(button);
    
        const success = function () {
          button.classList.add("success", "fa-check");
          button.classList.remove("fa-copy");
        };
    
        const failure = function () {
          button.classList.add("error", "fa-xmark");
          button.classList.remove("fa-copy");
        };
    
        button.addEventListener("click", function () {
          copyToClipboard(el.innerText).then(success, failure);
    
          setTimeout(function () {
            button.classList.add("fa-copy");
            button.classList.remove("success", "fa-check", "fa-xmark");
          }, 5000);
        });
      }
    }
    
    function copyToClipboard(text) {
      // clipboard API is only available in secure contexts
      if (window.navigator && window.navigator.clipboard) {
        return window.navigator.clipboard.writeText(text);
      } else {
        return new Promise(function (resolve, reject) {
          try {
            const el = document.createElement("textarea");
            el.textContent = text;
            el.style.position = "fixed";
            el.style.opacity = 0;
            document.body.appendChild(el);
            el.select();
            document.execCommand("copy");
    
            resolve();
          } catch (err) {
            reject(err);
          } finally {
            document.body.removeChild(el);
          }
        });
      }
    }
    
    if (document.readyState === "loading") {
      document.addEventListener("DOMContentLoaded", addCopyButtonCallbacks);
    } else {
      addCopyButtonCallbacks();
    }
    
    })
    ////////////////////////////////////////////////////////////////////////////////
    require(['jquery', 'headroom', 'headroom-jquery'], function($, Headroom) {
    
    // Manages the top navigation bar (hides it when the user starts scrolling down on the
    // mobile).
    window.Headroom = Headroom; // work around buggy module loading?
    $(document).ready(function () {
      $("#documenter .docs-navbar").headroom({
        tolerance: { up: 10, down: 10 },
      });
    });
    
    })
    ////////////////////////////////////////////////////////////////////////////////
    require(['jquery'], function($) {
    
    $(document).ready(function () {
      let meta = $("div[data-docstringscollapsed]").data();
    
      if (meta?.docstringscollapsed) {
        $("#documenter-article-toggle-button").trigger({
          type: "click",
          noToggleAnimation: true,
        });
      }
    });
    
    })
    ////////////////////////////////////////////////////////////////////////////////
    require(['jquery'], function($) {
    
    /*
    To get an in-depth about the thought process you can refer: https://hetarth02.hashnode.dev/series/gsoc
    
    PSEUDOCODE:
    
    Searching happens automatically as the user types or adjusts the selected filters.
    To preserve responsiveness, as much as possible of the slow parts of the search are done
    in a web worker. Searching and result generation are done in the worker, and filtering and
    DOM updates are done in the main thread. The filters are in the main thread as they should
    be very quick to apply. This lets filters be changed without re-searching with minisearch
    (which is possible even if filtering is on the worker thread) and also lets filters be
    changed _while_ the worker is searching and without message passing (neither of which are
    possible if filtering is on the worker thread)
    
    SEARCH WORKER:
    
    Import minisearch
    
    Build index
    
    On message from main thread
      run search
      find the first 200 unique results from each category, and compute their divs for display
        note that this is necessary and sufficient information for the main thread to find the
        first 200 unique results from any given filter set
      post results to main thread
    
    MAIN:
    
    Launch worker
    
    Declare nonconstant globals (worker_is_running,  last_search_text, unfiltered_results)
    
    On text update
      if worker is not running, launch_search()
    
    launch_search
      set worker_is_running to true, set last_search_text to the search text
      post the search query to worker
    
    on message from worker
      if last_search_text is not the same as the text in the search field,
        the latest search result is not reflective of the latest search query, so update again
        launch_search()
      otherwise
        set worker_is_running to false
    
      regardless, display the new search results to the user
      save the unfiltered_results as a global
      update_search()
    
    on filter click
      adjust the filter selection
      update_search()
    
    update_search
      apply search filters by looping through the unfiltered_results and finding the first 200
        unique results that match the filters
    
      Update the DOM
    */
    
    /////// SEARCH WORKER ///////
    
    function worker_function(documenterSearchIndex, documenterBaseURL, filters) {
      importScripts(
        "https://cdn.jsdelivr.net/npm/minisearch@6.1.0/dist/umd/index.min.js"
      );
    
      let data = documenterSearchIndex.map((x, key) => {
        x["id"] = key; // minisearch requires a unique for each object
        return x;
      });
    
      // list below is the lunr 2.1.3 list minus the intersect with names(Base)
      // (all, any, get, in, is, only, which) and (do, else, for, let, where, while, with)
      // ideally we'd just filter the original list but it's not available as a variable
      const stopWords = new Set([
        "a",
        "able",
        "about",
        "across",
        "after",
        "almost",
        "also",
        "am",
        "among",
        "an",
        "and",
        "are",
        "as",
        "at",
        "be",
        "because",
        "been",
        "but",
        "by",
        "can",
        "cannot",
        "could",
        "dear",
        "did",
        "does",
        "either",
        "ever",
        "every",
        "from",
        "got",
        "had",
        "has",
        "have",
        "he",
        "her",
        "hers",
        "him",
        "his",
        "how",
        "however",
        "i",
        "if",
        "into",
        "it",
        "its",
        "just",
        "least",
        "like",
        "likely",
        "may",
        "me",
        "might",
        "most",
        "must",
        "my",
        "neither",
        "no",
        "nor",
        "not",
        "of",
        "off",
        "often",
        "on",
        "or",
        "other",
        "our",
        "own",
        "rather",
        "said",
        "say",
        "says",
        "she",
        "should",
        "since",
        "so",
        "some",
        "than",
        "that",
        "the",
        "their",
        "them",
        "then",
        "there",
        "these",
        "they",
        "this",
        "tis",
        "to",
        "too",
        "twas",
        "us",
        "wants",
        "was",
        "we",
        "were",
        "what",
        "when",
        "who",
        "whom",
        "why",
        "will",
        "would",
        "yet",
        "you",
        "your",
      ]);
    
      let index = new MiniSearch({
        fields: ["title", "text"], // fields to index for full-text search
        storeFields: ["location", "title", "text", "category", "page"], // fields to return with results
        processTerm: (term) => {
          let word = stopWords.has(term) ? null : term;
          if (word) {
            // custom trimmer that doesn't strip @ and !, which are used in julia macro and function names
            word = word
              .replace(/^[^a-zA-Z0-9@!]+/, "")
              .replace(/[^a-zA-Z0-9@!]+$/, "");
    
            word = word.toLowerCase();
          }
    
          return word ?? null;
        },
        // add . as a separator, because otherwise "title": "Documenter.Anchors.add!", would not
        // find anything if searching for "add!", only for the entire qualification
        tokenize: (string) => string.split(/[\s\-\.]+/),
        // options which will be applied during the search
        searchOptions: {
          prefix: true,
          boost: { title: 100 },
          fuzzy: 2,
        },
      });
    
      index.addAll(data);
    
      /**
       *  Used to map characters to HTML entities.
       * Refer: https://github.com/lodash/lodash/blob/main/src/escape.ts
       */
      const htmlEscapes = {
        "&": "&",
        "<": "&lt;",
        ">": "&gt;",
        '"': "&quot;",
        "'": "&#39;",
      };
    
      /**
       * Used to match HTML entities and HTML characters.
       * Refer: https://github.com/lodash/lodash/blob/main/src/escape.ts
       */
      const reUnescapedHtml = /[&<>"']/g;
      const reHasUnescapedHtml = RegExp(reUnescapedHtml.source);
    
      /**
       * Escape function from lodash
       * Refer: https://github.com/lodash/lodash/blob/main/src/escape.ts
       */
      function escape(string) {
        return string && reHasUnescapedHtml.test(string)
          ? string.replace(reUnescapedHtml, (chr) => htmlEscapes[chr])
          : string || "";
      }
    
      /**
       * RegX escape function from MDN
       * Refer: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
       */
      function escapeRegExp(string) {
        return string.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
      }
    
      /**
       * Make the result component given a minisearch result data object and the value
       * of the search input as queryString. To view the result object structure, refer:
       * https://lucaong.github.io/minisearch/modules/_minisearch_.html#searchresult
       *
       * @param {object} result
       * @param {string} querystring
       * @returns string
       */
      function make_search_result(result, querystring) {
        let search_divider = `<div class="search-divider w-100"></div>`;
        let display_link =
          result.location.slice(Math.max(0), Math.min(50, result.location.length)) +
          (result.location.length > 30 ? "..." : ""); // To cut-off the link because it messes with the overflow of the whole div
    
        if (result.page !== "") {
          display_link += ` (${result.page})`;
        }
        searchstring = escapeRegExp(querystring);
        let textindex = new RegExp(`${searchstring}`, "i").exec(result.text);
        let text =
          textindex !== null
            ? result.text.slice(
                Math.max(textindex.index - 100, 0),
                Math.min(
                  textindex.index + querystring.length + 100,
                  result.text.length
                )
              )
            : ""; // cut-off text before and after from the match
    
        text = text.length ? escape(text) : "";
    
        let display_result = text.length
          ? "..." +
            text.replace(
              new RegExp(`${escape(searchstring)}`, "i"), // For first occurrence
              '<span class="search-result-highlight py-1">$&</span>'
            ) +
            "..."
          : ""; // highlights the match
    
        let in_code = false;
        if (!["page", "section"].includes(result.category.toLowerCase())) {
          in_code = true;
        }
    
        // We encode the full url to escape some special characters which can lead to broken links
        let result_div = `
            <a href="${encodeURI(
              documenterBaseURL + "/" + result.location
            )}" class="search-result-link w-100 is-flex is-flex-direction-column gap-2 px-4 py-2">
              <div class="w-100 is-flex is-flex-wrap-wrap is-justify-content-space-between is-align-items-flex-start">
                <div class="search-result-title has-text-weight-bold ${
                  in_code ? "search-result-code-title" : ""
                }">${escape(result.title)}</div>
                <div class="property-search-result-badge">${result.category}</div>
              </div>
              <p>
                ${display_result}
              </p>
              <div
                class="has-text-left"
                style="font-size: smaller;"
                title="${result.location}"
              >
                <i class="fas fa-link"></i> ${display_link}
              </div>
            </a>
            ${search_divider}
          `;
    
        return result_div;
      }
    
      self.onmessage = function (e) {
        let query = e.data;
        let results = index.search(query, {
          filter: (result) => {
            // Only return relevant results
            return result.score >= 1;
          },
          combineWith: "AND",
        });
    
        // Pre-filter to deduplicate and limit to 200 per category to the extent
        // possible without knowing what the filters are.
        let filtered_results = [];
        let counts = {};
        for (let filter of filters) {
          counts[filter] = 0;
        }
        let present = {};
    
        for (let result of results) {
          cat = result.category;
          cnt = counts[cat];
          if (cnt < 200) {
            id = cat + "---" + result.location;
            if (present[id]) {
              continue;
            }
            present[id] = true;
            filtered_results.push({
              location: result.location,
              category: cat,
              div: make_search_result(result, query),
            });
          }
        }
    
        postMessage(filtered_results);
      };
    }
    
    // `worker = Threads.@spawn worker_function(documenterSearchIndex)`, but in JavaScript!
    const filters = [
      ...new Set(documenterSearchIndex["docs"].map((x) => x.category)),
    ];
    const worker_str =
      "(" +
      worker_function.toString() +
      ")(" +
      JSON.stringify(documenterSearchIndex["docs"]) +
      "," +
      JSON.stringify(documenterBaseURL) +
      "," +
      JSON.stringify(filters) +
      ")";
    const worker_blob = new Blob([worker_str], { type: "text/javascript" });
    const worker = new Worker(URL.createObjectURL(worker_blob));
    
    /////// SEARCH MAIN ///////
    
    // Whether the worker is currently handling a search. This is a boolean
    // as the worker only ever handles 1 or 0 searches at a time.
    var worker_is_running = false;
    
    // The last search text that was sent to the worker. This is used to determine
    // if the worker should be launched again when it reports back results.
    var last_search_text = "";
    
    // The results of the last search. This, in combination with the state of the filters
    // in the DOM, is used compute the results to display on calls to update_search.
    var unfiltered_results = [];
    
    // Which filter is currently selected
    var selected_filter = "";
    
    $(document).on("input", ".documenter-search-input", function (event) {
      if (!worker_is_running) {
        launch_search();
      }
    });
    
    function launch_search() {
      worker_is_running = true;
      last_search_text = $(".documenter-search-input").val();
      worker.postMessage(last_search_text);
    }
    
    worker.onmessage = function (e) {
      if (last_search_text !== $(".documenter-search-input").val()) {
        launch_search();
      } else {
        worker_is_running = false;
      }
    
      unfiltered_results = e.data;
      update_search();
    };
    
    $(document).on("click", ".search-filter", function () {
      if ($(this).hasClass("search-filter-selected")) {
        selected_filter = "";
      } else {
        selected_filter = $(this).text().toLowerCase();
      }
    
      // This updates search results and toggles classes for UI:
      update_search();
    });
    
    /**
     * Make/Update the search component
     */
    function update_search() {
      let querystring = $(".documenter-search-input").val();
    
      if (querystring.trim()) {
        if (selected_filter == "") {
          results = unfiltered_results;
        } else {
          results = unfiltered_results.filter((result) => {
            return selected_filter == result.category.toLowerCase();
          });
        }
    
        let search_result_container = ``;
        let modal_filters = make_modal_body_filters();
        let search_divider = `<div class="search-divider w-100"></div>`;
    
        if (results.length) {
          let links = [];
          let count = 0;
          let search_results = "";
    
          for (var i = 0, n = results.length; i < n && count < 200; ++i) {
            let result = results[i];
            if (result.location && !links.includes(result.location)) {
              search_results += result.div;
              count++;
              links.push(result.location);
            }
          }
    
          if (count == 1) {
            count_str = "1 result";
          } else if (count == 200) {
            count_str = "200+ results";
          } else {
            count_str = count + " results";
          }
          let result_count = `<div class="is-size-6">${count_str}</div>`;
    
          search_result_container = `
                <div class="is-flex is-flex-direction-column gap-2 is-align-items-flex-start">
                    ${modal_filters}
                    ${search_divider}
                    ${result_count}
                    <div class="is-clipped w-100 is-flex is-flex-direction-column gap-2 is-align-items-flex-start has-text-justified mt-1">
                      ${search_results}
                    </div>
                </div>
            `;
        } else {
          search_result_container = `
               <div class="is-flex is-flex-direction-column gap-2 is-align-items-flex-start">
                   ${modal_filters}
                   ${search_divider}
                   <div class="is-size-6">0 result(s)</div>
                </div>
                <div class="has-text-centered my-5 py-5">No result found!</div>
           `;
        }
    
        if ($(".search-modal-card-body").hasClass("is-justify-content-center")) {
          $(".search-modal-card-body").removeClass("is-justify-content-center");
        }
    
        $(".search-modal-card-body").html(search_result_container);
      } else {
        if (!$(".search-modal-card-body").hasClass("is-justify-content-center")) {
          $(".search-modal-card-body").addClass("is-justify-content-center");
        }
    
        $(".search-modal-card-body").html(`
          <div class="has-text-centered my-5 py-5">Type something to get started!</div>
        `);
      }
    }
    
    /**
     * Make the modal filter html
     *
     * @returns string
     */
    function make_modal_body_filters() {
      let str = filters
        .map((val) => {
          if (selected_filter == val.toLowerCase()) {
            return `<a href="javascript:;" class="search-filter search-filter-selected"><span>${val}</span></a>`;
          } else {
            return `<a href="javascript:;" class="search-filter"><span>${val}</span></a>`;
          }
        })
        .join("");
    
      return `
            <div class="is-flex gap-2 is-flex-wrap-wrap is-justify-content-flex-start is-align-items-center search-filters">
                <span class="is-size-6">Filters:</span>
                ${str}
            </div>`;
    }
    
    })
    ////////////////////////////////////////////////////////////////////////////////
    require(['jquery'], function($) {
    
    // Modal settings dialog
    $(document).ready(function () {
      var settings = $("#documenter-settings");
      $("#documenter-settings-button").click(function () {
        settings.toggleClass("is-active");
      });
      // Close the dialog if X is clicked
      $("#documenter-settings button.delete").click(function () {
        settings.removeClass("is-active");
      });
      // Close dialog if ESC is pressed
      $(document).keyup(function (e) {
        if (e.keyCode == 27) settings.removeClass("is-active");
      });
    });
    
    })
    ////////////////////////////////////////////////////////////////////////////////
    require(['jquery'], function($) {
    
    $(document).ready(function () {
      let search_modal_header = `
        <header class="modal-card-head gap-2 is-align-items-center is-justify-content-space-between w-100 px-3">
          <div class="field mb-0 w-100">
            <p class="control has-icons-right">
              <input class="input documenter-search-input" type="text" placeholder="Search" />
              <span class="icon is-small is-right has-text-primary-dark">
                <i class="fas fa-magnifying-glass"></i>
              </span>
            </p>
          </div>
          <div class="icon is-size-4 is-clickable close-search-modal">
            <i class="fas fa-times"></i>
          </div>
        </header>
      `;
    
      let initial_search_body = `
        <div class="has-text-centered my-5 py-5">Type something to get started!</div>
      `;
    
      let search_modal_footer = `
        <footer class="modal-card-foot">
          <span>
            <kbd class="search-modal-key-hints">Ctrl</kbd> +
            <kbd class="search-modal-key-hints">/</kbd> to search
          </span>
          <span class="ml-3"> <kbd class="search-modal-key-hints">esc</kbd> to close </span>
        </footer>
      `;
    
      $(document.body).append(
        `
          <div class="modal" id="search-modal">
            <div class="modal-background"></div>
            <div class="modal-card search-min-width-50 search-min-height-100 is-justify-content-center">
              ${search_modal_header}
              <section class="modal-card-body is-flex is-flex-direction-column is-justify-content-center gap-4 search-modal-card-body">
                ${initial_search_body}
              </section>
              ${search_modal_footer}
            </div>
          </div>
        `
      );
    
      document.querySelector(".docs-search-query").addEventListener("click", () => {
        openModal();
      });
    
      document
        .querySelector(".close-search-modal")
        .addEventListener("click", () => {
          closeModal();
        });
    
      $(document).on("click", ".search-result-link", function () {
        closeModal();
      });
    
      document.addEventListener("keydown", (event) => {
        if ((event.ctrlKey || event.metaKey) && event.key === "/") {
          openModal();
        } else if (event.key === "Escape") {
          closeModal();
        }
    
        return false;
      });
    
      // Functions to open and close a modal
      function openModal() {
        let searchModal = document.querySelector("#search-modal");
    
        searchModal.classList.add("is-active");
        document.querySelector(".documenter-search-input").focus();
      }
    
      function closeModal() {
        let searchModal = document.querySelector("#search-modal");
        let initial_search_body = `
          <div class="has-text-centered my-5 py-5">Type something to get started!</div>
        `;
    
        searchModal.classList.remove("is-active");
        document.querySelector(".documenter-search-input").blur();
    
        if (!$(".search-modal-card-body").hasClass("is-justify-content-center")) {
          $(".search-modal-card-body").addClass("is-justify-content-center");
        }
    
        $(".documenter-search-input").val("");
        $(".search-modal-card-body").html(initial_search_body);
      }
    
      document
        .querySelector("#search-modal .modal-background")
        .addEventListener("click", () => {
          closeModal();
        });
    });
    
    })
    ////////////////////////////////////////////////////////////////////////////////
    require(['jquery'], function($) {
    
    // Manages the showing and hiding of the sidebar.
    $(document).ready(function () {
      var sidebar = $("#documenter > .docs-sidebar");
      var sidebar_button = $("#documenter-sidebar-button");
      sidebar_button.click(function (ev) {
        ev.preventDefault();
        sidebar.toggleClass("visible");
        if (sidebar.hasClass("visible")) {
          // Makes sure that the current menu item is visible in the sidebar.
          $("#documenter .docs-menu a.is-active").focus();
        }
      });
      $("#documenter > .docs-main").bind("click", function (ev) {
        if ($(ev.target).is(sidebar_button)) {
          return;
        }
        if (sidebar.hasClass("visible")) {
          sidebar.removeClass("visible");
        }
      });
    });
    
    // Resizes the package name / sitename in the sidebar if it is too wide.
    // Inspired by: https://github.com/davatron5000/FitText.js
    $(document).ready(function () {
      e = $("#documenter .docs-autofit");
      function resize() {
        var L = parseInt(e.css("max-width"), 10);
        var L0 = e.width();
        if (L0 > L) {
          var h0 = parseInt(e.css("font-size"), 10);
          e.css("font-size", (L * h0) / L0);
          // TODO: make sure it survives resizes?
        }
      }
      // call once and then register events
      resize();
      $(window).resize(resize);
      $(window).on("orientationchange", resize);
    });
    
    // Scroll the navigation bar to the currently selected menu item
    $(document).ready(function () {
      var sidebar = $("#documenter .docs-menu").get(0);
      var active = $("#documenter .docs-menu .is-active").get(0);
      if (typeof active !== "undefined") {
        sidebar.scrollTop = active.offsetTop - sidebar.offsetTop - 15;
      }
    });
    
    })
    ////////////////////////////////////////////////////////////////////////////////
    require(['jquery'], function($) {
    
    // Theme picker setup
    $(document).ready(function () {
      // onchange callback
      $("#documenter-themepicker").change(function themepick_callback(ev) {
        var themename = $("#documenter-themepicker option:selected").attr("value");
        if (themename === "auto") {
          // set_theme(window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light');
          window.localStorage.removeItem("documenter-theme");
        } else {
          // set_theme(themename);
          window.localStorage.setItem("documenter-theme", themename);
        }
        // We re-use the global function from themeswap.js to actually do the swapping.
        set_theme_from_local_storage();
      });
    
      // Make sure that the themepicker displays the correct theme when the theme is retrieved
      // from localStorage
      if (typeof window.localStorage !== "undefined") {
        var theme = window.localStorage.getItem("documenter-theme");
        if (theme !== null) {
          $("#documenter-themepicker option").each(function (i, e) {
            e.selected = e.value === theme;
          });
        }
      }
    });
    
    })
    ////////////////////////////////////////////////////////////////////////////////
    require(['jquery'], function($) {