Added documentation for release 2.0.0

Signed-off-by: Bharath Ramaswamy <[email protected]>

releases/2.0.0/_sphinx_design_static/design-tabs.js

@@ -0,0 +1,101 @@
+// @ts-check
+
+// Extra JS capability for selected tabs to be synced
+// The selection is stored in local storage so that it persists across page loads.
+
+/**
+ * @type {Record<string, HTMLElement[]>}
+ */
+let sd_id_to_elements = {};
+const storageKeyPrefix = "sphinx-design-tab-id-";
+
+/**
+ * Create a key for a tab element.
+ * @param {HTMLElement} el - The tab element.
+ * @returns {[string, string, string] | null} - The key.
+ *
+ */
+function create_key(el) {
+  let syncId = el.getAttribute("data-sync-id");
+  let syncGroup = el.getAttribute("data-sync-group");
+  if (!syncId || !syncGroup) return null;
+  return [syncGroup, syncId, syncGroup + "--" + syncId];
+}
+
+/**
+ * Initialize the tab selection.
+ *
+ */
+function ready() {
+  // Find all tabs with sync data
+
+  /** @type {string[]} */
+  let groups = [];
+
+  document.querySelectorAll(".sd-tab-label").forEach((label) => {
+    if (label instanceof HTMLElement) {
+      let data = create_key(label);
+      if (data) {
+        let [group, id, key] = data;
+
+        // add click event listener
+        // @ts-ignore
+        label.onclick = onSDLabelClick;
+
+        // store map of key to elements
+        if (!sd_id_to_elements[key]) {
+          sd_id_to_elements[key] = [];
+        }
+        sd_id_to_elements[key].push(label);
+
+        if (groups.indexOf(group) === -1) {
+          groups.push(group);
+          // Check if a specific tab has been selected via URL parameter
+          const tabParam = new URLSearchParams(window.location.search).get(
+            group
+          );
+          if (tabParam) {
+            console.log(
+              "sphinx-design: Selecting tab id for group '" +
+                group +
+                "' from URL parameter: " +
+                tabParam
+            );
+            window.sessionStorage.setItem(storageKeyPrefix + group, tabParam);
+          }
+        }
+
+        // Check is a specific tab has been selected previously
+        let previousId = window.sessionStorage.getItem(
+          storageKeyPrefix + group
+        );
+        if (previousId === id) {
+          // console.log(
+          //   "sphinx-design: Selecting tab from session storage: " + id
+          // );
+          // @ts-ignore
+          label.previousElementSibling.checked = true;
+        }
+      }
+    }
+  });
+}
+
+/**
+ *  Activate other tabs with the same sync id.
+ *
+ * @this {HTMLElement} - The element that was clicked.
+ */
+function onSDLabelClick() {
+  let data = create_key(this);
+  if (!data) return;
+  let [group, id, key] = data;
+  for (const label of sd_id_to_elements[key]) {
+    if (label === this) continue;
+    // @ts-ignore
+    label.previousElementSibling.checked = true;
+  }
+  window.sessionStorage.setItem(storageKeyPrefix + group, id);
+}
+
+document.addEventListener("DOMContentLoaded", ready, false);

releases/2.0.0/_static/aimet-furo.css

@@ -0,0 +1,98 @@
+/*
+ * AIMET color palette
+ */
+:root {
+    --aimet-blue: #3253dc;
+    --aimet-dark-blue: #0000ff;
+    --aimet-white: #ffffff;
+    --aimet-border-grey: #e0e0e0;
+    --aimet-menu-hover: #e3efff;
+    --aimet-menu-font-active: #0058ff;
+    --aimet-code-grey: #fafafa;
+    --aimet-light-blue: #e7f2fa;
+  }
+
+ aside.toc-drawer ul ul ul ul {
+   display: none;
+}
+
+.toctree-l3 {
+    display: none;
+}
+
+[for^="toctree-checkbox-"], [id^="toctree-checkbox-"] {
+    visibility: hidden;
+}
+
+/*
+ * Configure the appearance of code output box.
+ * Values are based on sphinx-gallery configuration
+*/
+.script-output {
+    color: black;
+    display: flex;
+    gap: 0.5em;
+}
+
+.script-output::before {
+    content: "Out:";
+    line-height: 1.4;
+    padding-top: 10px;
+}
+
+.script-output .highlight {
+    background: transparent;
+    flex-grow: 1;
+    overflow: auto;
+    /* Allow output block to take up maximum 25 lines */
+    max-height: 25em;
+}
+
+*.highlight pre, pre.literal-block {
+    background-color: var(--aimet-code-grey);
+}
+
+/*
+ * Glossary formatting
+*/
+[id^="term-"] {
+    font-weight: bold;
+}
+
+/*
+ * Heading formatting
+ */
+
+h1 {
+    font-size:2.5em;
+    margin-top:1.75rem;
+    margin-bottom:1rem;
+}
+
+h2 {
+    font-size:2em;
+    margin-top:1.75rem;
+    margin-bottom:1.25rem;
+    font-weight: normal;
+}
+
+h3 {
+    font-size:1.5em;
+    margin-top:1.25rem;
+    margin-bottom:1.25rem;
+    font-weight: normal;
+}
+
+h4 {
+    font-size:1.25em;
+    margin-top:1.25rem;
+    margin-bottom:1.25rem;
+    font-weight: normal;
+}
+
+h5 {
+    font-size:1.125em;
+    margin-top:1.25rem;
+    margin-bottom:1.25rem;
+    font-weight: normal;
+}