diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 0000000..ef40fab --- /dev/null +++ b/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 50c5a471c65279fad615ad2a6e72e794 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/_images/osvb.png b/_images/osvb.png new file mode 100644 index 0000000..01e833a Binary files /dev/null and b/_images/osvb.png differ diff --git a/_images/osvde.png b/_images/osvde.png new file mode 100644 index 0000000..ceed4a7 Binary files /dev/null and b/_images/osvde.png differ diff --git a/_images/pyCAPI.png b/_images/pyCAPI.png new file mode 100644 index 0000000..af263de Binary files /dev/null and b/_images/pyCAPI.png differ diff --git a/_images/runner_cfg.png b/_images/runner_cfg.png new file mode 100644 index 0000000..3e60f8a Binary files /dev/null and b/_images/runner_cfg.png differ diff --git a/_modules/index.html b/_modules/index.html new file mode 100644 index 0000000..2f9fedb --- /dev/null +++ b/_modules/index.html @@ -0,0 +1,271 @@ + + + + + + + + Overview: module code - Open Source Verification Bundle latest documentation + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+ +
+
+ +
+ +
+
+ +
+
+
+ + + + + Back to top + +
+
+ +
+ +
+ +
+
+ + +
+
+ + Made with Sphinx and @pradyunsg's + + Furo + +
+
+ +
+
+ +
+
+ +
+
+ + + + + \ No newline at end of file diff --git a/_modules/pyCAPI.html b/_modules/pyCAPI.html new file mode 100644 index 0000000..bb192c1 --- /dev/null +++ b/_modules/pyCAPI.html @@ -0,0 +1,368 @@ + + + + + + + + pyCAPI - Open Source Verification Bundle latest documentation + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+ +
+
+ +
+ +
+
+ +
+
+
+ + + + + Back to top + +
+
+ +
+ +
+
+

Source code for pyCAPI

+# Python Data Model for CAPI 3 core files
+
+# Authors:
+#   Unai Martinez-Corral
+#
+# Copyright 2021 Unai Martinez-Corral <unai.martinezcorral@ehu.eus>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+
+from typing import Dict, List, Union
+from pathlib import Path
+from dataclasses import dataclass, field
+from yamldataclassconfig.config import YamlDataClassConfig
+
+
+
+[docs] +@dataclass +class IpCoreConfig(YamlDataClassConfig): + """ + Each core file must contain an 'ipcore' field with the metadata of the design. + """ + + namespace: str = None + name: str = None + version: str = None
+ + + +
+[docs] +@dataclass +class FilesetConfig(YamlDataClassConfig): + """ + A Fileset is a group of sources of the same type, to be used together. + """ + + path: str = field(default_factory=str) + file_type: str = field(default_factory=str) + logical_name: str = field(default_factory=str) + files: List[str] = None
+ + + +
+[docs] +@dataclass +class Config(YamlDataClassConfig): + """ + Definition of the CAPI 3 format for core configuration files. + """ + + CAPI: int = None + + ipcore: IpCoreConfig = None + + # TODO Should be a Union for supporting a global 'file_type' + # filesets: Dict[str, Union[str, FilesetConfig]] = None + filesets: Dict[str, FilesetConfig] = None
+ + + +
+[docs] +def LoadCoreFile(coreFilePath): + """ + Load a CAPI 3 compliant core configuration file and unmarshal it. + + :param coreFilePath: location of the ``*.core`` file to be loaded. + """ + _cpath = Path(coreFilePath) + _core = Config() + _core.load(_cpath) + _core.FILE_PATH = _cpath + print(_core.FILE_PATH) + print("CAPI:", _core.CAPI) + print("IpCore:") + print(" namespace:", _core.ipcore.namespace) + print(" name:", _core.ipcore.name) + print(" version:", _core.ipcore.version) + print("Filesets:") + for key, val in _core.filesets.items(): + print(" - %s:" % key) + print(" path:", val.path) + print(" file_type:", val.file_type) + print(" logical_name:", val.logical_name) + print(" files:", val.files) + + return _core
+ +
+
+
+
+ + +
+
+ + Made with Sphinx and @pradyunsg's + + Furo + +
+
+ +
+
+ +
+
+ +
+
+ + + + + \ No newline at end of file diff --git a/_modules/pyCAPI/VUnit.html b/_modules/pyCAPI/VUnit.html new file mode 100644 index 0000000..e3799fe --- /dev/null +++ b/_modules/pyCAPI/VUnit.html @@ -0,0 +1,314 @@ + + + + + + + + pyCAPI.VUnit - Open Source Verification Bundle latest documentation + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+ +
+
+ +
+ +
+
+ +
+
+
+ + + + + Back to top + +
+
+ +
+ +
+
+

Source code for pyCAPI.VUnit

+# Python API for using CAPI 3 core files from VUnit
+
+# Authors:
+#   Unai Martinez-Corral
+#
+# Copyright 2021 Unai Martinez-Corral <unai.martinezcorral@ehu.eus>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+
+
+[docs] +def AddCoreFilesets(vunitHandle, core, filesets): + """ + Add the sources of some filesets from a CAPI 3 compliant core, into a VUnit + handle through VUnit's API (``add_library`` and ``add_source_files``). + + :param vunitHandle: handle to the VUnit object instance. + :param core: CAPI 3 compliant object (coming from LoadCoreFile). + :param filesets: name of the filesets to be added into the VUnit handle. + """ + _root = core.FILE_PATH.parent + + _defaultLib = "VUnitUserLib" + _sources = {_defaultLib: []} + + for fsetname in filesets: + if fsetname in core.filesets: + fset = core.filesets[fsetname] + _lib = _defaultLib if fset.logical_name == "" else fset.logical_name + if _lib not in _sources: + _sources[_lib] = [] + _sources[_lib] += [_root / fset.path / fstr for fstr in fset.files] + + for _lib, _files in _sources.items(): + vunitHandle.add_library(_lib).add_source_files(_files)
+ +
+
+
+
+ + +
+
+ + Made with Sphinx and @pradyunsg's + + Furo + +
+
+ +
+
+ +
+
+ +
+
+ + + + + \ No newline at end of file diff --git a/_modules/pyOSVDE/main.html b/_modules/pyOSVDE/main.html new file mode 100644 index 0000000..5a1d423 --- /dev/null +++ b/_modules/pyOSVDE/main.html @@ -0,0 +1,711 @@ + + + + + + + + pyOSVDE.main - Open Source Verification Bundle latest documentation + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+ +
+
+ +
+ +
+
+ +
+
+
+ + + + + Back to top + +
+
+ +
+ +
+
+

Source code for pyOSVDE.main

+#!/usr/bin/env python3
+
+# Authors:
+#   Unai Martinez-Corral
+#
+# Copyright 2021 Unai Martinez-Corral <unai.martinezcorral@ehu.eus>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+
+from sys import exit as sys_exit
+
+import tkinter as tk
+from tkinter import messagebox as mbox
+from tkinter import ttk as ttk, filedialog as fd
+
+from pathlib import Path
+from textwrap import dedent
+
+from pyGHDL.dom.InterfaceItem import GenericConstantInterfaceItem, GenericTypeInterfaceItem
+from pyGHDL.dom.NonStandard import Design, Document
+from pyGHDL.dom.Concurrent import (
+    ConcurrentBlockStatement,
+    ProcessStatement,
+    IfGenerateStatement,
+    CaseGenerateStatement,
+    ForGenerateStatement,
+    GenerateCase,
+    OthersGenerateCase,
+)
+from pyVHDLModel.SyntaxModel import (
+    Instantiation,
+    Mode,
+)
+from pyVHDLModelUtils.resolve import Symbols as resolve_Symbols
+
+from gitignore_parser import parse_gitignore as ignoreParser
+
+
+
+[docs] +class OSVDE(tk.Frame): + def __init__(self, parent): + super().__init__(parent) + parent.title("[OSVDE] Open Source VHDL Design Explorer") + + parent.state("zoomed") + + self.Frame = tk.Frame(parent) + self.FileTreeView = ttk.Treeview(self) + self.DesignTreeView = ttk.Treeview(self) + + self.FileTreeView.pack(fill="both", side=tk.TOP, expand=True) + self.DesignTreeView.pack(fill="both", side=tk.TOP, expand=True) + self.Frame.pack(fill=tk.X, side=tk.BOTTOM, expand=False) + self.pack(fill="both", expand=True) + + self._initImages() + parent.iconphoto(False, self.ImageLogo) + + self._initMenu(parent) + self._initFileTreeView() + self._initDesignTreeView() + + # tk.Button(self.Frame, text="Click to Open File", command=self.cbFile).pack( + # fill=tk.X, side=tk.LEFT, expand=True + # ) + # tk.Button(self.Frame, text="Click to Open Directory", command=self.cbDir).pack( + # fill=tk.X, side=tk.LEFT, expand=True + # ) + + self.Design = Design() + + self.cbDir() + + def _initImages(self): + """ + Load images for icons and logo. + """ + # https://www.flaticon.com/packs/file-folder-13 + imgDir = Path(__file__).parent / "img" + self.ImageLogo = tk.PhotoImage(file=imgDir / "icon.png") + imgDir16 = imgDir / "16" + self.Image = {} + for item in ( + "dir", + "file", + "lib", + "ent", + "generics", + "generic", + "ports", + "in", + "out", + "inout", + "archs", + "arch", + "inst", + ): + self.Image[item] = tk.PhotoImage(file=imgDir16 / "{}16.png".format(item)) + + def _initMenu(self, parent): + """ + Initialise the main Menu. + """ + + def cbAbout(): + # aboutWindow = tk.Toplevel(parent) + # aboutWindow.title("About Open Source VHDL Design Explorer (OSVDE)") + # aboutWindow.geometry("500x350") + # tk.Label(aboutWindow, text ="This is a new window").pack() + mbox.showinfo( + "About", + dedent( + """\ + Open Source VHDL Design Explorer (OSVDE) + <github.com/umarcor/osvb> + + Copyright 2021 Unai Martinez-Corral + <unai.martinezcorral@ehu.eus> + + Licensed under the Apache License, Version 2.0 + <apache.org/licenses/LICENSE-2.0> + """ + ), + ) + + self.Menu = tk.Menu(parent) + parent.config(menu=self.Menu) + + fileMenu = tk.Menu(self.Menu, tearoff=0) + fileMenu.add_command(label="Open File...", command=self.cbFile) + fileMenu.add_command(label="Open Directory...", command=self.cbDir) + fileMenu.add_separator() + fileMenu.add_command(label="About...", command=cbAbout) + fileMenu.add_separator() + fileMenu.add_command(label="Exit", command=parent.quit) + self.Menu.add_cascade(label="File", menu=fileMenu) + + # editMenu = tk.Menu(self.Menu, tearoff=0) + # editMenu.add_command(label="Undo") + # editMenu.add_command(label="Redo") + # self.Menu.add_cascade(label="Edit", menu=editMenu) + + def _initFileTreeView(self): + """ + Initialise the File TreeView (define the columns). + """ + ftw = self.FileTreeView + ftw["columns"] = "units" + ftw.heading("#0", text="Sources: **/*vhd") + ftw.heading("units", text="Units: entity(architecture,...)|<entity>(architecture,...)") + + def _initDesignTreeView(self): + """ + Initialise the Design TreeView (define the columns). + """ + dtw = self.DesignTreeView + dtw.heading("#0", text="Design hierarchies") + +
+[docs] + def cbDir(self): + """ + Callback for '*Open Directory...*'. + """ + dirName = fd.askdirectory(mustexist=True) + if dirName != "": + self.parseDir(Path(dirName)) + resolve_Symbols(self.Design) + self.loadFileTree() + self.loadDesignTree()
+ + +
+[docs] + def cbFile(self): + """ + Callback for '*Open File...*'. + """ + fileName = fd.askopenfilename() + self.parseFile(Path(fileName)) + resolve_Symbols(self.Design) + self.loadFileTree() + self.loadDesignTree()
+ + +
+[docs] + def parseDir(self, dirName: Path): + """ + Parse all the ``.vhd`` files found through a recursive glob, honoring ``osvdeignore`` files. + """ + ignores = [] + for item in dirName.glob("**/.osvdeignore"): + ignores.append((item.parent, ignoreParser(item))) + + for item in dirName.glob("**/*.vhd*"): + ignoreItem = False + for match in ignores: + if str(match[0]) in str(item) and match[1](item): + ignoreItem = True + break + if not ignoreItem: + self.parseFile(item)
+ + +
+[docs] + def parseFile(self, sourceFile: Path, library: str = "lib"): + """ + Add a VHDL source to the pyVHDLModel Design. + """ + print("parseFile: {}".format(sourceFile)) + lib = self.Design.GetLibrary(library) + self.Design.AddDocument(Document(sourceFile), lib)
+ + +
+[docs] + def loadFileTree(self, parent=""): + """ + Populate the FileTreeView with the data from the pyVHDLModel Design. + """ + ftw = self.FileTreeView + + def addTreeItem(parent, text, isDir, data=()): + return ftw.insert( + parent, + tk.END, + text=text, + values=data, + open=isDir, + image=self.Image["dir"] if isDir else self.Image["file"], + ) + + def traversePath(document, parts, parent): + item = parts[0] + isDir = len(parts) > 1 + + children = [iid for iid in ftw.get_children(parent) if ftw.item(iid)["text"] == item] + childrenLen = len(children) + + if isDir: + if childrenLen > 1: + raise Exception("Duplicated item text <{}>: {}".format(item, children)) + return traversePath( + document, + parts[1:], + addTreeItem(parent, item, True, ()) if childrenLen == 0 else children[0], + ) + + if len(children) > 0: + raise Exception("Item text <{}> exists already: {}".format(item, children)) + + units = {} + for entity in document.Entities: + units["<{}>".format(entity.Identifier)] = [arch.Identifier for arch in entity.Architectures] + + addTreeItem( + parent, + item, + False, + ("| ".join(["{}({})".format(key, ", ".join(val)) for key, val in units.items()])), + ) + + for document in self.Design.Documents: + traversePath(document, list(document.Path.parts), parent)
+ + +
+[docs] + def loadDesignTree(self, parent=""): + """ + Populate the DesignTreeView with the data from the pyVHDLModel Design. + """ + dtw = self.DesignTreeView + + def addTreeItem(parent, text, isOpen, image): + return dtw.insert(parent, tk.END, text=text, open=isOpen, image=self.Image[image]) + + def loadStatementsTree(item, statements): + for statement in statements: + + # Note: the following share the same base class 'Instantiation' + # ComponentInstantiation, EntityInstantiation, ConfigurationInstantiation + + if isinstance(statement, Instantiation): + addTreeItem(item, "{}: inst".format(statement.Label), False, "inst") + + elif isinstance(statement, ConcurrentBlockStatement): + instItem = addTreeItem(item, "{}: block".format(statement.Label), False, "file") + innerstatements = statement.Statements + if len(innerstatements) != 0: + loadStatementsTree(instItem, innerstatements) + + # Note: the following share the same base class 'GenerateStatement' + # ForGenerateStatement, CaseGenerateStatement, IfGenerateStatement + + elif isinstance(statement, IfGenerateStatement): + instItem = addTreeItem(item, "{}: if .. generate".format(statement.Label), False, "file") + loadStatementsTree( + addTreeItem( + instItem, + "if: {}".format(statement.IfBranch.Condition), + False, + "file", + ), + statement.IfBranch.Statements, + ) + for elsifbranch in statement.ElsifBranches: + loadStatementsTree( + addTreeItem( + instItem, + "elsif: {}".format(elsifbranch.Condition), + False, + "file", + ), + elsifbranch.Statements, + ) + if statement.ElseBranch is not None: + loadStatementsTree( + addTreeItem(instItem, "else:", False, "file"), + statement.ElseBranch.Statements, + ) + + elif isinstance(statement, CaseGenerateStatement): + instItem = addTreeItem(item, "{}: case .. generate".format(statement.Label), False, "file") + for case in statement.Cases: + if isinstance(case, GenerateCase): + loadStatementsTree( + addTreeItem( + instItem, + "case: {}".format(" | ".join([str(c) for c in case.Choises])), + False, + "file", + ), + case.Statements, + ) + elif isinstance(case, OthersGenerateCase): + loadStatementsTree( + addTreeItem(instItem, "others:", False, "file"), + case.Statements, + ) + + elif isinstance(statement, ForGenerateStatement): + instItem = addTreeItem( + item, + "{0}: for {1!s} generate".format(statement.Label, statement.Range), + False, + "file", + ) + innerstatements = statement.Statements + if len(innerstatements) != 0: + loadStatementsTree(instItem, innerstatements) + + elif isinstance(statement, ProcessStatement): + addTreeItem( + item, + "{}: process".format(statement.Label or "DefaultLabel"), + False, + "file", + ) + + for libName, lib in self.Design.Libraries.items(): + LibItem = addTreeItem(parent, libName, True, "lib") + for entity in lib.Entities: + EntityItem = addTreeItem(LibItem, entity.Identifier, False, "ent") + + generics = entity.GenericItems + if len(generics) != 0: + GenericsItem = addTreeItem(EntityItem, "Generics", False, "generics") + for generic in generics: + if isinstance(generic, GenericConstantInterfaceItem): + addTreeItem( + GenericsItem, + "{} [{}]".format(",".join(generic.Identifiers), generic.Subtype), + False, + "generic", + ) + elif isinstance(generic, GenericTypeInterfaceItem): + addTreeItem( + GenericsItem, + "type: {}".format(generic.Identifier), + False, + "generic", + ) + else: + print( + "[NOT IMPLEMENTED] Generic item class not supported yet: {0}", + generic.__class__.__name__, + ) + + ports = entity.PortItems + if len(ports) != 0: + PortsItem = addTreeItem(EntityItem, "Ports", False, "ports") + for port in ports: + addTreeItem( + PortsItem, + "{} [{}]".format(",".join(port.Identifiers), port.Subtype), + False, + "out" if port.Mode is Mode.Out else "inout" if port.Mode is Mode.InOut else "in", + ) + + architectures = entity.Architectures + if len(architectures) != 0: + ArchitecturesItem = addTreeItem(EntityItem, "Architectures", False, "archs") + for architecture in entity.Architectures: + loadStatementsTree( + addTreeItem(ArchitecturesItem, "{}".format(architecture.Identifier), False, "arch"), + architecture.Statements, + )
+
+ + + # TODO: + # - Add icons for process, block and generate(s) + # - https://icon-icons.com/icon/production-process/149888 + # - Add check for 'null' in GHDL's Sanity? + + # TODO: + # Strictly, elaboration is required for relating Entities and Architectures. + # However, there are three solutions: + # - Do a naive elaboration, by simple name matching. + # - Implement the elaboration in pyVHDLModel. + # - Use pyGHDL.libghdl for elaboration. + # The most sensible solution is to use the first one, skip the second one, and work on the last one. + # Currently, we are using `pyVHDLModelUtils.resolve.Symbols`, contributed by Patrick. + # In the near future, he might add those and other helper functions into an specific package, sibling + # to pyVHDLModel and pyGHDL. + + +if __name__ == "__main__": + sys_exit(OSVDE(tk.Tk()).mainloop()) +
+
+
+
+ + +
+
+ + Made with Sphinx and @pradyunsg's + + Furo + +
+
+ +
+
+ +
+
+ +
+
+ + + + + \ No newline at end of file diff --git a/_modules/pyVHDLModelUtils/fmt.html b/_modules/pyVHDLModelUtils/fmt.html new file mode 100644 index 0000000..4d7ce17 --- /dev/null +++ b/_modules/pyVHDLModelUtils/fmt.html @@ -0,0 +1,290 @@ + + + + + + + + pyVHDLModelUtils.fmt - Open Source Verification Bundle latest documentation + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+ +
+
+ +
+ +
+
+ +
+
+
+ + + + + Back to top + +
+
+ +
+ +
+
+

Source code for pyVHDLModelUtils.fmt

+from typing import Union
+from pyGHDL.dom.Symbol import (
+    SimpleSubtypeSymbol,
+    ConstrainedCompositeSubtypeSymbol,
+)
+
+
+# From pyGHDL's dom/formatting/prettyprint.py
+
+[docs] +def SubtypeIndication(subtypeIndication: Union[SimpleSubtypeSymbol, ConstrainedCompositeSubtypeSymbol]) -> str: + """ + Format the subtype indication of generics/ports as an string. + """ + if isinstance(subtypeIndication, SimpleSubtypeSymbol): + return "{type}".format(type=subtypeIndication.SymbolName) + elif isinstance(subtypeIndication, ConstrainedCompositeSubtypeSymbol): + constraints = [] + for constraint in subtypeIndication.Constraints: + constraints.append(str(constraint)) + + return "{type}({constraints})".format(type=subtypeIndication.SymbolName, constraints=", ".join(constraints)) + else: + raise Exception("Unhandled subtype kind '{type}'.".format(type=subtypeIndication.__class__.__name__))
+ +
+
+
+
+ + +
+
+ + Made with Sphinx and @pradyunsg's + + Furo + +
+
+ +
+
+ +
+
+ +
+
+ + + + + \ No newline at end of file diff --git a/_modules/pyVHDLModelUtils/resolve.html b/_modules/pyVHDLModelUtils/resolve.html new file mode 100644 index 0000000..048148b --- /dev/null +++ b/_modules/pyVHDLModelUtils/resolve.html @@ -0,0 +1,291 @@ + + + + + + + + pyVHDLModelUtils.resolve - Open Source Verification Bundle latest documentation + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+ +
+
+ +
+ +
+
+ +
+
+
+ + + + + Back to top + +
+
+ +
+ +
+
+

Source code for pyVHDLModelUtils.resolve

+from pyGHDL.dom.NonStandard import Design
+
+
+
+[docs] +def Symbols(design: Design) -> None: + """ + Resolve some symbols after parsing, but without complete analysis and elaboration. + """ + ArchitecturesToEntities(design)
+ + + +
+[docs] +def ArchitecturesToEntities(design: Design) -> None: + """ + Resolve architectures to entities by simple name matching. + """ + for library in design.Libraries.values(): + for entityName, architectures in library.Architectures.items(): + for entity in library.Entities: + if entity.Identifier == str(entityName): + for architecture in architectures: + entity.Architectures.append(architecture)
+ +
+
+
+
+ + +
+
+ + Made with Sphinx and @pradyunsg's + + Furo + +
+
+ +
+
+ +
+
+ +
+
+ + + + + \ No newline at end of file diff --git a/_modules/pyVHDLModelUtils/sphinx.html b/_modules/pyVHDLModelUtils/sphinx.html new file mode 100644 index 0000000..ca4d933 --- /dev/null +++ b/_modules/pyVHDLModelUtils/sphinx.html @@ -0,0 +1,468 @@ + + + + + + + + pyVHDLModelUtils.sphinx - Open Source Verification Bundle latest documentation + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+ +
+
+ +
+ +
+
+ +
+
+
+ + + + + Back to top + +
+
+ +
+ +
+
+

Source code for pyVHDLModelUtils.sphinx

+from typing import List, Union
+from pathlib import Path
+from textwrap import indent
+from io import StringIO
+from contextlib import redirect_stdout
+from tabulate import tabulate
+
+from pyGHDL.dom.NonStandard import Design, Document, Library
+from pyGHDL.dom.DesignUnit import Entity
+
+from pyVHDLModelUtils.resolve import Symbols as resolve_Symbols
+from pyVHDLModelUtils.fmt import SubtypeIndication as format_SubtypeIndication
+
+
+DESIGN = Design()
+
+
+
+[docs] +def initDesign(root: Union[str, Path], **kwargs) -> None: + """ + Initialize a Design and analyze sources. + + Each argument after `root` defines a library name and the type is expected to be a list of patterns. + + :param root: Location of the root for all provided relative paths. This is relative to the base directory of the build. + """ + root = Path(root) if isinstance(root, str) else root + print(".. NOTE:: Output of initDesign:\n") + for library, patterns in kwargs.items(): + lib = DESIGN.GetLibrary(library) + print(" * {0}\n".format(library)) + for pattern in patterns: + for item in root.glob(pattern): + # FIXME: is_relative_to is new in Python 3.9 (see https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.is_relative_to) + # Therefore, we use try..except for backwards compatibility. + # print(" * {0}\n".format(item.relative_to(root) if item.is_relative_to(root) else item)) + try: + path = item.relative_to(root) + except e: + path = item + print(" * {0}\n".format(path)) + f = StringIO() + with redirect_stdout(f): + DESIGN.AddDocument(Document(item), lib) + print(indent(f.getvalue(), " * ")) + print("") + resolve_Symbols(DESIGN)
+ + + +STYLES = ["rst:list", "rst:table"] + + +
+[docs] +def printDocumentationOfEntity_rstList(entity: Entity, lib: Library = None) -> None: + """ + Print documentation of an Entity using style 'rst:list'. + """ + print("Entity *{0}* from Library *{1}*:\n".format(entity.Identifier, lib.Identifier)) + + print("* Generics:\n") + for generic in entity.GenericItems: + print( + " * *{0}* : ``{1}``{2}".format( + ", ".join(generic.Identifiers), + format_SubtypeIndication(generic.Subtype), + "" if generic.DefaultExpression is None else " := ``{0!s}``".format(generic.DefaultExpression), + ) + ) + print("\n* Ports:\n") + for port in entity.PortItems: + print( + " * *{0}* : {1} ``{2}``{3}".format( + ", ".join(port.Identifiers), + port.Mode, + format_SubtypeIndication(port.Subtype), + "" if port.DefaultExpression is None else " := ``{0!s}``".format(port.DefaultExpression), + ) + ) + print("\n* Architectures:\n") + for architecture in entity.Architectures: + print(" * *{0}*".format(architecture.Identifier))
+ + + +
+[docs] +def printDocumentationOfEntity_rstTable(entity: Entity, lib: Library = None) -> None: + """ + Print documentation of an Entity using style 'rst:table' (through 'tabulate'). + """ + + def printTable(data, headers=None, caption=None): + table = tabulate(data, tablefmt="rst") if headers is None else tabulate(data, headers, tablefmt="rst") + if caption is not None: + print(".. table:: {0}\n :align: center\n".format(caption)) + print(indent(table, " ")) + else: + print(table) + print("\n") + + name = "{0}{1}".format("" if lib is None else "{0}.".format(lib.Identifier), entity.Identifier) + + printTable( + [ + [ + ", ".join(generic.Identifiers), + "``{0}``".format(format_SubtypeIndication(generic.Subtype)), + "" if generic.DefaultExpression is None else "``{0!s}``".format(generic.DefaultExpression), + ] + for generic in entity.GenericItems + ], + headers=["Identifiers", "Type", "Default"], + caption="{0} Generics".format(name), + ) + + printTable( + [ + [ + ", ".join(port.Identifiers), + port.Mode, + "``{0}``".format(format_SubtypeIndication(port.Subtype)), + "" if port.DefaultExpression is None else "``{0!s}``".format(port.DefaultExpression), + ] + for port in entity.PortItems + ], + headers=["Identifiers", "Mode", "Type", "Default"], + caption="{0} Ports".format(name), + ) + + printTable( + [ + [ + architecture.Identifier, + len(architecture.Statements), + ] + for architecture in entity.Architectures + ], + headers=["Identifier", "Number of statements"], + caption="{0} Architectures".format(name), + )
+ + + +
+[docs] +def printDocumentationOf(targets: List[str] = None, style: str = "rst:list") -> None: + """ + Generate documentation of resources (either a unit or a whole file). + + Supported syntaxes: + + * libraryName.entityName + * TODO: libraryName.entityName(architectureName) + * TODO: libraryName.packageName + * TODO: libraryName.configurationName + * TODO: libraryName.architectureName + * TODO: relative/path/to/file + * TODO: absolute/path/to/file + + :param targets: list of resources to generate the documentation for. + :param style: format of the output. Supported values are: 'rst:list' and 'rst:table'. + """ + if targets is None: + print("Design content:\n") + for libName, lib in DESIGN.Libraries.items(): + ents = lib.Entities + print("* Library *{0}* [{1} entities]\n".format(libName, len(ents))) + for ent in ents: + print(" * Entity: *{0}*\n".format(ent.Identifier)) + for arch in ent.Architectures: + print(" * Architecture: *{0}*\n".format(arch.Identifier)) + print("") + return + + if style not in STYLES: + raise Exception("Unknown style <{0}>".format(style)) + + for target in targets: + # TODO: support other argument types: + # - libName.packageName + # - path/to/file (print all the units in the file) + parts = target.split(".") + assert len(parts) == 2 + libName, entityName = parts + lib = DESIGN.GetLibrary(libName) + entity = None + for entity in lib.Entities: + if entity.Identifier == entityName: + break + else: + raise Exception("Entity {0} not found in library {1}.".format(entityName, libraryName)) + + if style == "rst:list": + printDocumentationOfEntity_rstList(entity, lib) + continue + + if style == "rst:table": + printDocumentationOfEntity_rstTable(entity, lib) + continue
+ +
+
+
+
+ + +
+
+ + Made with Sphinx and @pradyunsg's + + Furo + +
+
+ +
+
+ +
+
+ +
+
+ + + + + \ No newline at end of file diff --git a/_sources/apis/core.rst.txt b/_sources/apis/core.rst.txt new file mode 100644 index 0000000..581776d --- /dev/null +++ b/_sources/apis/core.rst.txt @@ -0,0 +1,111 @@ +.. _API:Core: + +Core +#### + +This section covers the definition of configuration/declaration files for users to describe the sources and parameters +that compose an HDL project. +Several JSON/YAML/INI formats are supported by different tools in the ecosystem. +Here, we don't want to focus as much on the specific file format as we do want to understand the structure of the data. +A Python module is proposed for interacting with those file formats. + +Introduction +------------ + +:awesome:`FuseSoC ` is a package manager and build abstraction tool for FPGA/ASIC development, written in +Python. It is based on a declarative data sctructure, defined as a YAML configuration file format named Core API (CAPI). +The current version 2 of the format is named ``CAPI2`` (see :web:`fusesoc.rtfd.io: ref/capi2 `). +A single YAML file can be used for defining all the sources and parameters related to multiple tools for simulation, +verification, synthesis, etc. + +Initially, FuseSoC was a monolith that allowed interacting with FPGA/ASIC tools directly. +Later, :awesome:`Edalize ` was split, and an API named EDA Metadata (EDAM) was proposed for the interaction +from FuseSoC or other frontends. +:awesome:`Hdlmake ` is one of the projects that can use Edalize through EDAM. + +Nevertheless, the proposal for funneling all open source project management tools through Edalize didn't engage the +broad open source hardware tooling community. Multiple projects (such as +:awesome:`VUnit `, +:awesome:`pyIPCMI `, +:awesome:`PyFPGA `, +:awesome:`tsfpga ` +or +:awesome:`Xeda ` +) provide independent APIs and CLIs for interacting with FPGA/ASIC tools. +Most of them are also standalone monoliths with custom configuration file formats. +Therefore, workflows are not compatible, and users need duplicated configurations for addressing the requirements of +each tool. + +There have been some integration efforts; for instance, supporting VUnit scripts as FuseSoC/Edalize targets. +However, there is a paradigm conflict, since FuseSoC expects to be the entrypoint and Edalize is to be the backend. +Therefore, integration of other tools is only conceived as plugins in the already constrained framework. +Doing so breaks the workflows that the user bases of other projects do rely on. + +The proposal in this bundle is to provide a reusable Python module named pyCAPI, for reading CAPI files and manipulating +the data through a pythonic API. +pyCAPI allows FPGA/ASIC tool management projects to consume ``*.core`` configuration files non-intrusively, by providing +complementary import APIs. +Thus the CLIs in the existing workflows are preserved, without forcing FuseSoC as a frontend and/or Edalize as a +backend. +Hopefully, pyCAPI reduces the burden for users to try and learn new tools, while developers/maintainers can carefully +analyse possible integration strategies with regard to the other APIs in the architecture. + +.. figure:: ../_static/pyCAPI.png + :alt: pyCAPI usage block diagram + :align: center + + Usage of pyCAPI as a utility library for multiple EDA management projects. + +FuseSoC does contain some Python code for reading and parsing CAPI2 files (see :gh:`olofk/fusesoc: fusesoc/capi2 `). +Unfortunately, it is challenging to work with. +On the one hand, it uses :web:`pyyaml ` for reading ``*.core`` files as Python dictionaries and lists. +As a result, the procedure for providing Python classes is manual and prone to error. +On the other hand, the format is documented in the sources of the code, but the code itself is undocumented. + +Conversely, pyCAPI is a proof of concept based on Python :mod:`py:dataclasses` for direct (un)marshalling of YAML +to/from Python classes. +Hence, the CAPI2 format is not supported as-is yet: some non compliant fields were modified, and the prototype is +limited to reading filesets. +This work-in-progress version of CAPI is marked as ``3``, for avoiding conflicts with existing ``*.core`` files. +Still, pyCAPI does already allow VUnit to read ``*.core`` files for declaring HDL sources and the ``logical_name`` of +the libraries where they need to be compiled. +I.e., it allows providing a working proof of concept, constrainted to the simulation/verification scope of this bundle. + +Feedback and contributions for making pyCAPI compatible with and supported by FuseSoC, VUnit, PyFPGA, pyIPCMI, etc. are +very welcome! +:gh:`Open an issue ` or :web:`join the chat `! + +CAPI reference +-------------- + +.. autoclass:: pyCAPI.IpCoreConfig() + +.. autoclass:: pyCAPI.FilesetConfig() + +.. autoclass:: pyCAPI.Config() + +.. autofunction:: pyCAPI.LoadCoreFile + +.. autofunction:: pyCAPI.VUnit.AddCoreFilesets + +References +---------- + +* :gh:`yukihiko-shinoda/yaml-dataclass-config` +* :web:`su0.io: Strict YAML deserialization with marshmallow ` +* :gh:`antonblanchard/microwatt: microwatt.core ` +* :gh:`VLSI-EDA/PoC: .pyIPCMI ` +* :gdocs:`j.mp/openfpga-diagram: Open Source (FOSS) FPGA (EDA) Tooling Interchange Formats + Toolchain parts <1DWZ0G8vehkuZTPs5N3AQqIvZZtLMGzC8i0MWPRP54O4>` +* :gh:`ghdl/ghdl-language-server#12 ` :gh:`ghdl/ghdl-language-server#80 ` +* :gh:`cocotb[wiki]: Python Test Runner Proposal | Models `. +* :gh:`Core HAMMER settings ` +* :gh:`kactus2/kactus2dev` + + * :web:`research.tuni.fi/system-on-chip/tools ` + * :web:`gitter.im/hdl/community?at=6132117a5b92082de1807f54 `: + *"I also worked together with the Kactus2 devs and had monthly meeting for a few years to push that as the preferred + solution and I've been periodically trying to build a reference design that uses Kactus2+FuseSoC"*. + +* :web:`olofkindgren.blogspot.com: IP-XACT: The good, the bad and the outright madness ` +* :web:`youtube.com: ORPSoCv3 - OpenRISC Project Meeting 2012 ` +* :gh:`fvutils/ivpm` diff --git a/_sources/apis/logging.rst.txt b/_sources/apis/logging.rst.txt new file mode 100644 index 0000000..cb59ce8 --- /dev/null +++ b/_sources/apis/logging.rst.txt @@ -0,0 +1,121 @@ +.. _API:Logging: + +Logging +####### + +Unarguably, the most relevant feature of a testing/verification ecosystem is a robust solution for reporting test results +and for providing feedback to the users. +Since most executions are to be run unattended, spotting regressions needs to be reliable and must provide a quick +procedure for reproducing issues locally. +Therefore, logging features are tightly related to :ref:`API:Tool` and :ref:`API:Runner`. + +Terminal +******** + +In the terminal, VUnit provides a coloured summary of the tests and the results at the end of the execution of a +``run.py`` script. +By default, logging is saved to files and not shown in the terminal. +However, CLI option ``-v`` allows printing the content. +Moreover, VUnit's VHDL library ``logging`` allows using custom loggers with fine grained control of the scope and the +consumers (CSV files and/or display/screen). + +.. figure:: https://vunit.github.io/_images/vunit_demo.gif + :alt: Interactive VUnit session + :width: 600px + :align: center + + An interactive VUnit session. + +Nonetheless, in complex projects, users do typically handle several run scripts, for testing different units/modules of +the designs. +The recommended approach for those cases is using :web:`pytest `, a framework built on top of the +built-in :py:mod:`unittest` unit testing framework in Python. +Similarly to VUnit, pytest provides automatic discovery, marks and hooks for fine grained control of test execution. + +Waveforms +********* + +The most widespread format for dumping waveforms is Value Change Dump (VCD), defined in the Verilog language (IEEE Std +1364-1995). +Six years later, an Extended VCD (EVCD) was defined in IEEE Std 1364-2001. +VCD is simple and compact, which allowed it to be used in fields other than Verilog simulation tools. +For instance, GHDL supports dumping VCD files. +Since VCD files are text files, some tools use VCDGZ for referring to VCD compressed using zlib/gzip. + +VCD/EVCD can be read by multiple tools: + +* :awesome:`GTKWave ` +* :gh:`veripool/dinotrace` +* :ref:`Notebook:sigrok` +* :gh:`psurply/dwfv` +* :web:`wavedrom.com`, :gh:`wavedrom/vcdrom` and :gh:`wavedrom/zoom`. +* :gh:`Nic30/d3-wave` +* :gh:`raczben/fliplot` +* :gh:`lachlansneff/ligeia` +* :gh:`yne/vcd` +* :gh:`toem/impulse.vscode` +* :gh:`bmpenuelas/hdlcomposer` +* :gh:`phillbush/vcd2svg` +* :gh:`Ben1152000/sootty` +* :gh:`Toroid-io/vcd2wavedrom` +* :gh:`cirosantilli/vcdvcd` +* :web:`wavetrace.io` + +However, being a 20+ year old format defined for Verilog, VCD has certain limitations: + +* Data cannot be accessed randomly, as it has to be sequentially parsed. +* Periodic signals are not compressed, so they take a lot of space. +* File size is huge, because it is plain text. + +Anthony J. Bybell has gathered much knowledge about alternatives through the decades he's been building and maintaining +GTKWave. +It supports FST, LXT, LXT2 and VZT formats. +See appendices C, D and F of the :web:`GTKWave User's Guide `. +GHDL supports saving/reading waveforms as FST files, which are much smaller than VCD and they handle the same signal +types. + +On the other hand, neither VCD nor FST can handle certain signal types from the VHDL language. +There is neither any equivalent in the VHDL LRM. +Tristan Gingold, author of GHDL, implemented a format named GHW for allowing all VHDL types to be dumped. +He also contributed a reader to GTKWave, which allows visualizing them. + +.. NOTE:: + GTKWave provides multiple tools for converting waveforms between any of the supported formats. + That is not trivial because some conversions are lossy or suboptimal. + See appendix A of the :web:`GTKWave User's Guide ` and subdir + :gh:`gtkwave/gtkwave: gtkwave3-gtk3/src/helpers `. + See also :gh:`gtkwave/gtkwave#70 `. + However, as far as we are aware, no other independent repository exists which is focused on providing a toolkit for + manipulating *any* waveform programmatically. + If GTKWave helpers are buildable/usable independently of GTKWave, it might be desirable to provide bindings in Python, + Rust,... along with an API to the database. + +Recently, Lachlan Sneff implemented Streamed Value Change Blocks (SVCB) in :gh:`lachlansneff/ligeia`, a +work-in-progress "*replacement for gtkwave, written in Rust with high-performance and larger-than-memory traces in mind*". + +Apart from dealing with large waveforms, there are some other formats which are used for documentation purposes: + +* :gh:`WaveJSON ` +* LaTeX (:web:`tikz-timing `) + +Moreover, there are several work in progress solutions for providing TCL plumbing to allow using vendor waveform viewers +and GTKWave automatically and/or interactively: + +* :gh:`VUnit/vunit#690 ` +* :gh:`VUnit/vunit#622 ` + +With regard to post-processing of waveforms, see the following references: + +* :ref:`Notebook:fpconv` +* :gh:`avidan-efody/coverage`: implementation of post-process coverage, and batch waveform search. +* :gl:`xiretza/ghw-rs` +* :gh:`Nic30/pyDigitalWaveTools` +* :gh:`ics-jku/wal` +* :gh:`Wren6991/asciiwave` + +.. _API:Logging:OSVR: + +pyEDAA.Reports +************** + +See :doc:`reports:index`. diff --git a/_sources/apis/project.rst.txt b/_sources/apis/project.rst.txt new file mode 100644 index 0000000..cd87ad2 --- /dev/null +++ b/_sources/apis/project.rst.txt @@ -0,0 +1,53 @@ +.. _API:Project: + +Project +####### + +This section covers the definition of an API for binding the sources and options from the :ref:`API:Core` to the +interfaces in :ref:`API:Tool`, :ref:`API:Runner` and :ref:`API:Logging`. +The Project and Design management API handles tools independent information (files/filesets, primary design units, +testbenches, constraints, etc.) and some tool specific parameters. + +* Project: a set of sources (HDL, software, data, assets, configuration files, etc.) for handling multiple designs. +* Design: a design unit, the dependencies, the parent units (testbenches and BoardTop) and the parameters for execution. + +This is probably the most complex piece, because it is the less constrained. +Interaction with tools and manipulation of file formats are technically limited by the interfaces and capabilities in +those. +Therefore, although there is flexibility in the implementation of :ref:`API:Core`, :ref:`API:Tool`, +:ref:`API:Runner` and :ref:`API:Logging`, all of them need to match some external resource. +Conversely, defining what a project is and how to handle it tends to be specific for each use case (say organisation, +company, open source project...), so there is a vast space of different workflows, all similar but particular enough. +Therefore, the elaboration of the API in this section is delayed until others are defined, since that will allow working +on a finite scope. + +Nevertheless, there are some features available already for dealing with "whole repositories" of VHDL sources. +The proofs of concept below showcase pyGHDL.dom, the Python Document Object Model (DOM) interface built on top of GHDL's +parsing capabilities. + +.. toctree:: + :caption: Proofs of concept + + project/pyVHDLModelUtils + project/OSVDE + project/DocGen + +References +========== + +* :gdocs:`EDA integration: managing projects for simulation and implementation <1qThGGqSVQabts-4imn5zY5BMptp1-Q2rGiNKHDH1Pbk>` + +* Registers: + + * :web:`tsfpga: Register code generation ` + * :web:`cheby ` + * :gh:`SystemRDL register description language ` + * :gh:`RgGen ` + * :gh:`wzab/agwb` + * :web:`airhdl ` + +* :gh:`dbhi/vsc-hdl` + +* :gh:`orestesmas/pycirkuit` + +* :gh:`pieter3d/simview` diff --git a/_sources/apis/project/DocGen.rst.txt b/_sources/apis/project/DocGen.rst.txt new file mode 100644 index 0000000..649e241 --- /dev/null +++ b/_sources/apis/project/DocGen.rst.txt @@ -0,0 +1,255 @@ +.. _API:Project:DocGen: + +Documentation generation +######################## + +Automatic documentation generation of hardware designs is one of the main purposes of having a machine-readable project +description format along with a library providing a Document Object Model (DOM). +Some of the features to be implemented on top of :ref:`API:Project:pyVHDLModelUtils` are the following: + +* Entity symbol: + + * :web:`Symbolator ` + + * :gh:`hdl/symbolator` + * :gh:`hdl/pyHDLParser` + + * :web:`schemdraw.rtfd.io: Circuit Elements » Integrated Circuits ` + + * :web:`xhdl ` + * :gh:`LaurentCabaret/pyVhdl2Sch` + +* Single page HTML/reStructuredText/markdown body (see :gh:`TerosHDL CLI examples `). +* :web:`Sphinx ` project/domain with cross-references (placeholder: :gh:`Paebbels/sphinxcontrib-vhdldomain`). +* Diagrams: + + * For Sphinx (see :ref:`Integration with Sphinx » Diagrams `). + * For asciidoctor (see :web:`Asciidoctor Diagram `). + +.. _API:Project:DocGen:Sphinx: + +Integration with Sphinx +======================= + +:web:`Sphinx ` is the *de facto* static site generator (SSG) used for building documentation of +Python projects. +It was originally created for :doc:`Python `, and it has support for documenting software projects in several +languages. Since many open source EDA projects and CLIs are written in Python, Sphinx is probably the most used SSG. +It's used by SymbiFlow, GHDL, VUnit, pyVHDLModel/pyVHDLParser, cocotb, TerosHDL, Boolector, edalize/fusesoc, +Wishbone (FOSSi), SpinalHDL, tsfpga... + +Additional features can be added to Sphinx through :web:`extensions `. +For instance, :web:`intersphinx ` allows +cross-referencing content across sites, as if they were local references. +That is really handy for building knowledge as a community. + +The default plaintext markup language used by Sphinx is :web:`reStructuredText `. +Other markup languages, such as Markdown, can be imported through extensions, however, not all cross-reference features +are available when using those. + +Overall, there are four approaches for adding content with custom processing to a site built with Sphinx: + +* Execute before Sphinx: + + * `html_static_path`: content in the *static* paths is copied to the output's `_static` directory, overriding existing + sources with the same name. + This is typically used for adding images and/or customising the CSS. + * `html_extra_path`: content in *extra* paths is copied as-is to the output directory, overriding existing sources + with the same name. + This can be used for adding static content generated with a different generator. + +* Built into Sphinx: + + * `exec`: a generic directive (such as the ones proposed in :web:`stackoverflow.com/a/18143318`) + allows executing arbitrary Python code which generates reStructuredText output through `print` statements. + * Ad-hoc directive: as explained in :web:`Developing extensions for Sphinx `, + there are several objects whose API can be used when writing extensions: Application, Environment, Builder and Config. + Those allow fine-grained integration into Sphinx's internals, potentially bypassing the reStructuredText parsing + layer. + This is the end-goal for tightly integrated and customised functionality. + +.. _API:Project:DocGen:Sphinx:exec: + +*exec* directive +---------------- + +The generic `exec` extension (see :ghsrc:`doc/exec.py `) is based on :web:`stackoverflow.com/a/18143318`. +It allows executing arbitrary Python code which prints reStructuredText output. + +Setup is done by adding `exec` to the `extensions` variable of the ``conf.py``. +Depending on the location of `exec.py`, it might be necessary to add ``sys.path.insert(0, abspath("."))``. +Other than that, users (developers of the arbitrary Python code) don't need to know internals of Sphinx, but just print +regular reStructuredText statements. + +However, a main caveat of the current implementation is that Sphinx will never fail. +That is, even if the arbitrary code fails, the Sphinx build is reported as successful. +That's because errors are shown as an admonition instead of making the build fail. +As a result, manual inspection of the output is required (desirable). + +Moreover, currently no context is passed to the Python code. +Therefore, it is not possible to know where it belongs in the hierarchy of the document. +This is a limitation for generating headers and other context dependent statements. + +.. NOTE:: + Should you want to help improve the implementation of this directive, :gh:`let us know `! + +Lists and tables +---------------- + +This section showcases a naive approach for documenting VHDL design units using pyGHDL.dom. +It is based on :ref:`API:Project:DocGen:Sphinx:exec` and the ``sphinx`` module of :ref:`API:Project:pyVHDLModelUtils`. + +First, `initDesign` needs to be executed, in order to provide the lists of sources and VHDL library names. + +.. NOTE:: + Currently, there is no specific JSON/YAML format supported for this task. + Find work in progress in section :ref:`API:Core`. + +.. code-block:: python + :caption: Loading design sources. + + .. exec:: + from pyVHDLModelUtils.sphinx import initDesign + initDesign( + '..', + AXI4 = ["AXI4Stream/src/*.vhd"], + fpconv = ["fpconv/*.vhd"] + ) + +The output of *initDesign* is a NOTE containing the result of parsing the sources with pyGHDL.dom. +If a failure was produced, an admonition of type ERROR is shown instead. + +.. exec:: + from pyVHDLModelUtils.sphinx import initDesign + initDesign( + '..', + AXI4 = ["AXI4Stream/src/*.vhd"], + fpconv = ["fpconv/*.vhd"] + ) + +Then, `printDocumentationOf` allows generating the documentation of libraries and/or design units. +By default, the content is shown where the directive was called. +In case of failure, an admonition of type ERROR is shown. + +.. code-block:: python + :caption: Printing a summary of the content. + + .. exec:: + from pyVHDLModelUtils.sphinx import printDocumentationOf + printDocumentationOf() + +.. exec:: + from pyVHDLModelUtils.sphinx import printDocumentationOf + printDocumentationOf() + +At the moment, two different styles are supported for printing the documentation of entities. + +List style: + +.. code-block:: python + :caption: Printing the documentation of a unit (style 'rst:list'). + + .. exec:: + from pyVHDLModelUtils.sphinx import printDocumentationOf + printDocumentationOf(["AXI4.axis_buffer"]) + +.. exec:: + from pyVHDLModelUtils.sphinx import printDocumentationOf + printDocumentationOf(["AXI4.axis_buffer"]) + +Table style: + +.. code-block:: python + :caption: Printing the documentation of a unit (style 'rst:table'). + + .. exec:: + from pyVHDLModelUtils.sphinx import printDocumentationOf + printDocumentationOf( + ["AXI4.axis_buffer"], + 'rst:table' + ) + +.. exec:: + from pyVHDLModelUtils.sphinx import printDocumentationOf + printDocumentationOf( + ["AXI4.axis_buffer"], + 'rst:table' + ) + +.. NOTE:: + This is a demo for showcasing the capabilities of pyGHDL.dom and pyVHDLModel. + Should you want to help improve the implementation for it to be more usable in practice, :gh:`let us know `! + +VHDL Domain +----------- + +:gh:`Paebbels/sphinxcontrib-vhdldomain` is work in progress for adding a VHDL language domain to Sphinx. +That is, a set of nestable directives resembling the architecture of pyVHDLModel. +The purpose is twofold: + +* Allow a better integration of the content into Sphinx, rather than generating reStructuredText output from arbitrary + Python functions. +* Allow users to specify a pyVHDLModel project by handwriting directives in reStructuredText sources, by either pointing + to individual files or explicitly describing all the items. + +See :gh:`Paebbels/sphinxcontrib-vhdldomain#4 `. + +There is also :gh:`CESNET/sphinx-vhdl`, which uses a custom basic parser (:gh:`CESNET/sphinx-vhdl: src/sphinxvhdl/autodoc.py `) +and multiple custom Sphinx directives (:gh:`CESNET/sphinx-vhdl: src/sphinxvhdl/vhdl.py `). + +.. _API:Project:DocGen:Sphinx:Diagrams: + +Diagrams +-------- + +Both GHDL and Yosys allow generating diagrams of synthesised designs. + +* ``ghdl synth --out=dot`` generates a :web:`Graphviz ` DOT diagram of the netlist AST. + +* :gh:`ghdl/ghdl-yosys-plugin` allows using GHDL as a frontend for Yosys. + + * As explained in :ref:`ghdl.github.io/ghdl/synthesis » Yosys plugin `, ghdl-yosys-plugin and Yosys + allow converting VHDL to EDIT, SMT, BTOR2, FIRRTL, etc. + +* Yosys's :web:`show ` command allows generating a Graphviz DOT diagram and compiling + it to a graphics file (say SVG). + + * Optionally, command :web:`aigmap ` can map the logic to and/nand gates only, + before generating the diagram. + + * Alternatively, :gh:`nturley/netlistsvg` allows generating SVG schematics from Yosys' JSON netlist output. + +By combining those tools, diagrams of a given VHDL design can be generated as follows: + +.. code-block:: shell + + ~# yosys -p 'ghdl --std=08 design.vhd -e primary_unit secondary_unit; prep; write_json netlist.json' + ~# netlistsvg netlist.json -o netlist.svg + ~# convert netlist.svg netlist.png + +.. IMPORTANT:: + There is an Sphinx extension named :gh:`sphinxcontrib-hdl-diagrams `, + which wraps Yosys and (optionally) netlistsvg in a directive. + That allows including diagrams in the docs without manually calling yosys and netlistsvg. + For instance: + + .. code-block:: restructuredtext + + .. hdl-diagram:: file.v + :type: netlistsvg + :module: name + :flatten: + + However, since sphinxcontrib-hdl-diagrams depends on combining the WASM version of Yosys and netlistsvg (which is + JavaScript), it does not support VHDL yet. + There is work in progress for using the extension with "natively" installed tools, as well as supporting VHDL and + mixed-language designs. + See + :gh:`SymbiFlow/sphinxcontrib-hdl-diagrams#65 `, + :gh:`SymbiFlow/sphinxcontrib-hdl-diagrams#72 ` + and :gh:`SymbiFlow/sphinxcontrib-hdl-diagrams#73 `. + +References +========== + +* :bb:`cdelker/schemdraw` (:web:`schemdraw.rtfd.io`). diff --git a/_sources/apis/project/OSVDE.rst.txt b/_sources/apis/project/OSVDE.rst.txt new file mode 100644 index 0000000..9b81e77 --- /dev/null +++ b/_sources/apis/project/OSVDE.rst.txt @@ -0,0 +1,118 @@ +.. _API:Project:OSVDE: + +Open Source VHDL Design Explorer (OSVDE) +######################################## + +OSVDE is GUI for hardware designers to understand and use projects/repositories. +It allows exploring the HDL sources, entities/hierarchies, testbenches, tasks, etc. +It is mostly meant for VHDL designers (but not only) and particularly for users of VHDL >= 2008. + +.. IMPORTANT:: + OSVDE is a proof of concept for prototyping the integration of multiple pieces in the OSVB. + It is not actively developed *per se*, but used as an umbrella for pyVHDLModel, pyGHDL, pyCAPI, etc. + A practical usage of the features prototyped in OSVDE is found in :gh:`Hardware Studio ` + (see :web:`umarcor.github.io/hwstudio/doc: Structure `). + +OSVDE is a GUI tool written in Python only, using :doc:`py:library/tkinter`, *the standard Python interface to the Tk +GUI toolkit* (see :doc:`py:faq/gui`). +The motivation for using both Python and tkinter is reducing the dependencies to the bare minimum available on several +plataforms. +As said, the purpose of OSVDE is not to provide the best performance for (very) large designs, but it's for prototyping +the integration of other pieces such as pyCAPI, pydoit and OSVR. + +Installation +============ + +Install a recent version of GHDL and a matching pyGHDL. +As explained in :ref:`ghdl:USING:QuickStart:Python`, the following pip command can be used: + +.. code-block:: + + pip3 install git+https://github.com/ghdl/ghdl.git@$(ghdl version hash) + +Alternatively, get a tarball/zipfile of the GHDL repository, extract it, and set ``PYTHONPATH`` accordingly. + +Then, retrieve this repository (OSVB) and install the dependencies of pyOSVDE: + +.. code-block:: + + pip3 install -r mods/pyOSVDE/requirements.txt + +Usage +===== + +Start OSVDE by executing ``PYTHONPATH=$(pwd)/mods ./mods/pyOSVDE/main.py``. +By default, the '*Open Directory...*' is triggered, asking the user to select a directory containing VHDL sources. +Upon selection, the whole directory is scanned recursively, searching for either ``*.vhd*`` or ``.osvdeignore`` files, +and all the VHDL sources are added to pyVHDLModel :ref:`vhdlmodel:vhdlmodel-design` as a :ref:`vhdlmodel:vhdlmodel-document` +of a :ref:`vhdlmodel:vhdlmodel-library`. +Then, the Design model is used for generating the content of the GUI. + +.. HINT:: + Ignore files use the same syntax as regular ``.gitignore`` files, and prevent OSVDE from processing some content. + In fact, :pypi:`gitignore-parser` is used for parsing ``.osvdeignore`` files. + +.. ATTENTION:: + Currently, pyGHDL may crash (produce a segmentation fault) if "too many" files are analysed at the same time. + That is actually a bug, because GHDL itself can handle the same sources for simulation and/or synthesis. + While the bug is being fixed, it is recommended to use ``.osvdeignore`` files for testing OSVDE with a limited number + of sources. + +.. _fig:osvde: +.. figure:: ../../_static/osvde.png + :alt: Repository NEORV32 opened in OSVDE + :width: 100% + :align: center + + Repository :gh:`stnolting/neorv32` opened in OSVDE. + +As shown in :numref:`fig:osvde`, at the top part of OSVDE the hierarchy of the source files is shown. +For each VHDL source, a column shows the units (entities and/or architectures) defined in it. +As a complement, at the bottom part the logical hierarchy of the units is shown, grouped by library. +For each entity, the generics and ports are shown, including the *name*, *type* and (for ports only) *mode*. +Architectures are shown too, and within them concurrent statements such as instantiations and generates. + +.. IMPORTANT:: + For now, ``*.vhd*`` files are scanned only, and all of them are analysed into library ``lib``. + That is because the definition of the Filesets and the Project is out of the scope of OSVDE. + As discussed above, pyCAPI and the project API are to be reused in OSVDE for that purpose. + +Future work +=========== + +Some enhancements and features we would like to integrate into OSVDE are the following: + +* Dependency tree and logic hierarchy elaboration through GHDL. + +* Task running/triggering: + + * Discovery of VUnit run scripts (see + :web:`VSCode TerosHDL `, + :web:`VSCode VUnit Test Explorer `, + :web:`Sigasi Studio XPRT `). + * Discovery of pydoit task definition files (see :ref:`API:Tool`). + + * Allow running tasks and showing the results in a window. + + * '*Edit source in editor*' or '*Open project in editor*', where IDE is VSCode, (neo)vim, emacs, notepad++... + +* :ref:`API:Project:DocGen`. + +* Pretty printing, formatting... + + * Fixed style (see GHDL's :ref:`--pp-html ` and :gh:`ghdl-dom `). + * Customisable style (see + :gh:`jeremiah-c-leary/vhdl-style-guide`, + :gh:`VHDLTool`). + * :gh:`AdiuvoEngineering/VHDL_Coding_Rules`. + +* pyVHDLModel/pyGHDL enhancements: + + * Preserve comments. + * Preserve identifier casing. + +OSVDE reference +=============== + +.. autoclass:: pyOSVDE.main.OSVDE() + :private-members: False diff --git a/_sources/apis/project/pyVHDLModelUtils.rst.txt b/_sources/apis/project/pyVHDLModelUtils.rst.txt new file mode 100644 index 0000000..a02b04e --- /dev/null +++ b/_sources/apis/project/pyVHDLModelUtils.rst.txt @@ -0,0 +1,88 @@ +.. _API:Project:pyVHDLModelUtils: + +pyVHDLModelUtils +################ + +pyVHDLModel +=========== + +:gh:`vhdl/pyVHDLModel` is an abstract language model for VHDL written in Python. +That is, a set of classes that represent the items found in VHDL sources, and utils for manipulating and interacting +with those classes. +The generation of an specific object tree for an specific VHDL codebase is done by a frontend. +Currently supported frontends are :gh:`pyGHDL ` and :gh:`Paebbels/pyVHDLParser`. + +GHDL is the most complete open source VHDL parser and analyser, and more complete than several vendor tools. +However, GHDL is written in Ada, and it was not initially designed for the analysis features to be used standalone. +Therefore, most developers of tooling around the VHDL language do typically not use GHDL but try reimplementing the +parsing themselves. +That is the case of +:web:`VUnit `, +:web:`TerosHDL `, +:web:`Symbolator `, +:web:`vhdl-style-guide `, +:gh:`VHDLTool`, +:gh:`Nic30/hdlConvertor`, +etc. +All of those projects need some understanding of the models they are dealing with, and they use regular expressions, +:gh:`tree-sitter/tree-sitter`, :web:`ANTLR ` or similar general purpose parser engines. +That is unfortunate because many of them do use Python, so the effort duplication in the community might be +significantly reduced if they could interact with GHDL's parser/analysis through Python. + +Since 2021, pyVHDLModel and pyGHDL provide a ready-to-use solution. +By using those, developers can get a *pythonic* representation of VHDL sources, using less than 10 lines of Python code +which depend on GHDL and Python only. +We believe that projects such as the ones mentioned above could greatly benefit from using pyVHDLModel, as long as they +are good with depending on GHDL. + +.. NOTE:: + Projects which don't want to depend on a binary/compiled tool (GHDL), can use a Python only frontend for pyVHDLModel. + That is precisely the purpose of :gh:`pyVHDLParser ` (actually where + :gh:`pyVHDLModel ` was conceived). + However, pyVHDLParser is not as mature as (py)GHDL yet. + +Utils +===== + +pyVHDLModel and pyGHDL are still being shaped and enhanced in order to provide higher abstraction features on top of parsing. +Moreover, there are some helper functions written on top of pyVHDLModel, which don't fit in the same repository but can +be reused by multiple projects. +:ghsrc:`pyVHDLModelUtils ` collects some of those helpers, until we decide a better location for them. + +.. NOTE:: + We are aware that reworking an stable codebase is not the most appealing task, so developers of existing tools might + not be willing to use pyVHDLModel straightaway. + In this context, the main purpose of pyVHDLModelUtils, :ref:`API:Project:OSVDE` and :ref:`API:Project:DocGen` + is to showcase pyVHDLModel and to build a critical mass for creating higher abstraction features on top. + Potential users of pyVHDLModel are all the developers of tools which benefit from programmatically using knowledge + about a VHDL codebase. + +pyVHDLModelUtils reference +========================== + +resolve +------- + +Currently, pyVHDLModel and pyGHDL.dom provide a SyntaxModel only. +That is, the model is built from parsing the sources, without further analysis or elaboration. +As a result, symbols and cross-references between units are not resolved. +This package provides some *naive* Symbol resolution features. +In the future, we expect to use pyGHDL.libghdl for elaboration. + +.. automodule:: pyVHDLModelUtils.resolve + +fmt +--- + +Getting an string representation of some elements such as (sub)types might be cumbersome. +This package handles formatting those. + +.. automodule:: pyVHDLModelUtils.fmt + +sphinx +------ + +Since Sphinx is written in Python, packages can be imported and used for generating content. +This package provides functions for including the documentation of hardware designs in Sphinx projects. + +.. automodule:: pyVHDLModelUtils.sphinx diff --git a/_sources/apis/runner.rst.txt b/_sources/apis/runner.rst.txt new file mode 100644 index 0000000..a3e4921 --- /dev/null +++ b/_sources/apis/runner.rst.txt @@ -0,0 +1,40 @@ +.. _API:Runner: + +Runner +###### + +This section covers the interface for deciding which workflows to execute, whether to run the in parallel, which +specific parameters to use and how to interpret exit/termination codes of tools, as well as gathering/buffering the +stdout/stderr and partially processing it. +Therefore, the runner API is closely related to :ref:`API:Tool`, both of them belonging to layer 2 (Workflows) of +the :ref:`EDAA:Concept`. + +In the case of VUnit, the runner is composed by sibling interfaces written in Python and HDL, due to the limitations in +some older revisions of VHDL to get the termination status. + +*TBC* + +.. figure:: ../_static/runner_cfg.png + :alt: Passing runner configuration from Python to HDL + :width: 500 px + :align: center + + Strategies to pass the runner configuration from Python to HDL. + +* :gh:`VUnit/vunit#772 ` + +References +========== + +* :gl:`IEEE-P1076/VHDL-Issues#13: Python API ` + +* :web:`Test Anything Protocol ` + + * :gh:`python-tap/tappy`: a set of tools for working with the TAP in Python. + +* :gh:`FuseSoc Verification Automation (fsva) ` is an HDL testbench runner based on + :awesome:`FuseSoc `. + It fetches targets named with certain patterns in ``.core`` files; which can be executed in parallel; stdout/stderr + are captured and parsed. + +* :web:`ttask ` diff --git a/_sources/apis/tool.rst.txt b/_sources/apis/tool.rst.txt new file mode 100644 index 0000000..631bf6c --- /dev/null +++ b/_sources/apis/tool.rst.txt @@ -0,0 +1,196 @@ +.. _API:Tool: + +Tool +#### + +This section covers the interface for executing sequences of tasks (workflows) involving interaction with EDA tools. +Since each tool has different mechanisms for achieving the same results, the purpose of this interface is to provide +homogeneous wrappers that use data from :ref:`API:Project` for deciding which tasks to execute, the order, file +dependencies and artifacts. +In terms of the :ref:`EDAA:Concept`, this piece belongs to layer 2, which consumes the specific EDA interfaces in layer 1 +(EDA) and layer 4 (Project). + +Hardware design workflows are known for combining multiple (probably over a dozen) smaller tools for getting the desired +artifact(s) from some HDL sources (see :web:`Hammer VLSI Flow, slide 'A Real VLSI Flow' `). +Many hardware projects use traditional Makefiles or similar Python based solutions for aiding the designers. +However, most of them are meant for a given set of tasks and a limited set of predefined workflows. +Adding or customising stages requires modifying the tool, unless specific hooks are available. +That is the case with, e.g., VUnit, Edalize or PyFPGA. + +Supporting multiple workflows is challenging because they are quickly changing, as new tools in the open source EDA +ecosystem get mature enough. +At the same time, users will always find creative ways for fulfilling in-house requirements and extending the workflows +with their ad-hoc software and verification infrastructure. +Therefore, we need a task management tool where workflows can be provided dynamically. +Instead of prefixed workflows, we need to define composable tasks that users can aggregate for building their paths. + +For example, the following are just some of the possible workflows starting with some VHDL sources. +Each of them is subject to have some sources common/shared to others task, along with some specific sources. + +* GHDL (sim) +* GHDL (sim) + cocotb +* VUnit > GHDL (sim) +* VUnit > GHDL (sim) + cocotb +* OSVVM > GHDL (sim) +* GHDL (synth) > VHDL > GHDL (sim) +* GHDL (synth) > Verilog > Verilator (sim) +* GHDL (synth) > VHDL > Vendor [&V] +* GHDL (synth) > VHDL > Verific (plugin) > Yosys [&Y] +* GHDL (synth) > Verilog > Yosys [&Y] + + * Y> JSON > nextpnr + * Y> BLIF > VTR + * Y> Verilog > Vendor + + * V> Xilinx Vivado + * V> Xilinx ISE + * V> Intel/Altera Quartus + * V> Siemens ModelSim/QuestaSim + * V> Aldec RivieraPRO/ActiveHDL + * ... + +.. NOTE:: + In fact, all the EDA ecosystem might be modelled using a similar approach. For execution, graphs need to be acyclic. + However, a larger cyclic graph can be created by combining multiple DAGs. Therefore, diagrams such as the ones + shown in :gh:`hdl/awesome#98 ` might be created by visualizing the actual tasks/tools that + people are using *in the wild*. + +A task runner which allows users to compose workflows was prototyped in :gh:`dbhi/run`. +There, a graphviz dot digraph is used for defining the workflows as a Directed Acyclic Graph (DAG). +Nodes can be either sources, jobs or artifacts. +The actual content of each node is defined in a sibling JSON file. +See :gh:`dbhi/run: example/graph.dot ` and :gh:`dbhi/run: example/config.json `. +:web:`gonum ` is used for computing the topological sort of the workflows. +Then, a CLI is provided for listing, inducing or executing. +In retrospect, picking golang for implementing the tool might have not been the best decision for a tool targeted at EDA +tooling. However, the same concepts can be applied, using already available Python libraries: + +* :gh:`pydoit/doit` (:web:`pydoit.org`) and :web:`Invoke ` + are Python task execution tools and libraries, which allow defining/organizing task functions from a ``.py`` file. + + * See a proof of concept for using pydoit in NEORV32: :gh:`stnolting/neorv32#110 `. + +* :web:`NetworkX ` is a network analysis library in Python, which provides graph algorithms for + topological sorting and probably other of the features implemented in dbhi/run. + In NetworkX "*Nodes can be 'anything'*", meaning we may have pydoit/Invoke tasks be NetworkX nodes. + At the same time, "*edges can hold arbitrary data*", so we can have artifacts encoded in the edges, and use them + together with source nodes. + +In fact, :web:`Apache Airflow ` implements these concepts, and it's written in Python. +Furthermore, :web:`Google's Cloud Composer ` is managed workflow orchestration service built +on Apache Airflow. +Airflow might be too specific, as it is meant for orchestrating and schduling web/remote workers in a pool, which is out +of the scope of this bundle/project. +Nonetheless, there are several shared :web:`Concepts ` +and some of their implementation decisions might be a good reference. + +Moreover the design document for the reimplementation of Edalize (see :gh:`Edalize (Slight return) `) +does also propose a similar architecture, even though terms such as directed acyclic graph or topological sorting are +not explicitly used. +Precisely, the section about :gh:`Implementation ` +proposes using EDAM as the unified format for passing parameters between nodes. + +On the other hand, as shown in the diagram of section :ref:`API:Core`, developers of Edalize and PyFPGA have been +lately working towards making integration easier: + +* Experimental support for *launchers* was added to Edalize (:gh:`olofk/edalize@f8b3f66 `). + That allows wrapping the lower level commands. + +* :gh:`OpenFlow ` was split from PyFPGA. + OpenFlow wraps (Docker/Podman) containers, allowing usage of EDA tools without installing them natively. + By default, containers from :gh:`hdl/containers` are used. + +By combining both solutions, users can use Edalize with containers. +Anyhow, extending OpenFlow for supporting multiple and dynamically defined workflows imposes similar challenges as the +ones described for Edalize. + +Even though using Python based libraries is proposed here, the architecture is not limited to Python tasks. +It is indeed desirable to reuse existing CLI or shell scripts, instead of being forced to rewrite them. +That is compulsory when dealing with vendor tools. +Furthermore, some SymbiFlow scripts for using QuickLogic devices are currently written in bash. +Therefore, having them available in the same workflow as the Python tasks makes integration easier. +In fact, both Edalize and PyFPGA are generators and wrappers around TCL scripts and/or Makefiles. + +Summarising, we should agree on some common format for defining what a task is, which are the inputs and the +outputs. +That might be EDAM. +However, that is also related to pyCAPI and pyOSVR, since Source and Report nodes (aka edge payloads) should satisfy +those formats. +Therefore, we need to analyse whether those can be wrapped in EDAM. +Then, we should document how to compose and execute those tasks with pydoit/Invoke/NetworkX/Airflow; +or some custom solution if those don't fit. +From this point of view, Edalize and PyFPGA might be rethought as frontends (project managers) and backends (task +providers) of the task execution core. + +References +========== + +* :gdocs:`EDA integration: managing projects for simulation and implementation <1qThGGqSVQabts-4imn5zY5BMptp1-Q2rGiNKHDH1Pbk>` + +* :gdocs:`Open Source EDA: building, packaging, installing <10_MqFjTIYVVuOJlusJydsp4KOcmrrHk03__7ME5thOI>` + +* :gh:`create schema for EDAM format (olofk/edalize#288) ` + +* SymbiFlow + + * :web:`SymbiFlow Publically Accessible Docs ` + * :gdocs:`bit.ly/edda-conda-eda-spec: Conda based system for FPGA and ASIC Dev <1BZcSzU-ur0J02uO5FSGHdJHYGnRfr4n4Cb7PMubXOD4>` + * :gdocs:`Next Conda Work <11XFnJ0ExBgE1pMQksw0rQerAZo3F83AVIu2YK1pbg1k>` + * :gh:`SymbiFlow/make-env` + * :gdocs:`edalize.autosetup <1IMVrSmMO5wqTV3W22Bv2PeKtMHO3WSyCwHm3N-Wkwbk>` + * :gdocs:`Tim's suggestions for a edalize v2 <1VakRJV0Pv4eM_hJnCCfh2l3bCMD3y07p6hFpc7z2Kg4>` + * :gdraws:`VHDL version of "OpenTitan (and other SV designs) using open tools (for FPGAs and ASICS)" <16kKGSo84Xitmr5BiCJG3faNWt3maoKs-EHftUPDaM64>` + * :gdraws:`SystemVerilog flows (for OpenTitan and other SV designs) using open tools (for FPGAs and ASICS) <1GEjCoLwY57bsuZoj5ymyXoToIEOC0H4j2SEYsqQupM8>`. + +* :gh:`cocotb[wiki]: Python Test Runner Proposal `. + +* :gh:`Highly Agile Masks Made Effortlessly from RTL (HAMMER) `. + + * HAMMER imports tools as Python classes. + See :gh:`ucb-bar/hammer: src/hammer-vlsi/README.md `. + * :web:`HAMMER: A Platform For Agile Physical Design [EECS-2020-28] `. + +* :gh:`sifive/wake` + + * :web:`sifive.github.io/wake/contents.html` + +* Other task execution/automation tools: + + * :gh:`facebookresearch/hydra` + * :gh:`chriscardillo/gusty` + * :gh:`ray-project/ray` + + * :web:`docs.ray.io: Ray design patterns ` + + * Not based on Python: + + * :web:`bazel.build` + + * :gh:`hdl/bazel_rules_hdl` + + * :web:`cmake.org` + * :web:`gradle.org` + * :web:`ninja-build.org` + + * Remote execution: + + * :web:`Argo Workflows - The workflow engine for Kubernetes ` + * :gh:`Remote Execution API ` + * :web:`n8n.io` + + * :gh:`n8n-io/n8n` + +* :gh:`ktbarrett.github.io: _drafts/tool-automation.md ` + + * Find a discussion about the capabilities and limitations of pydoit in :gitter:`hdl/community?at=60f6b567926ce249e5759d03`. + +* :gh:`qarlosalberto/fpga-knife` + +* :web:`DMTN-025: A survey of workflow management systems ` + +* :gh:`fvutils/vlsim` + +* `chipflow.io `__ + + * `ChipFlow: Technical Overview `__, + `Microelectronics User Group Meeting, TWEPP 2021 Topical Workshop on Electronics for Particle Physics `__. diff --git a/_sources/egs/axi4stream.rst.txt b/_sources/egs/axi4stream.rst.txt new file mode 100644 index 0000000..39f7b45 --- /dev/null +++ b/_sources/egs/axi4stream.rst.txt @@ -0,0 +1,123 @@ +.. _Examples:AXI4Stream: + +SISO AXI4 Stream +################ + +The purpose of this example is to showcase a testing setup for a core with Single Input Single Output (SISO) AXI4 Stream +interfaces. +This is typically found in streaming Digital Signal Processing (DSP) applications. +For illustration purposes, the same UUT is tested using verification components and run scripts from several frameworks. + +:ghsrc:`AXI4Stream/src ` contains the VHDL sources of a SISO AXI4 Stream loopback buffer. +Those sources are the same as the ones in the :gh:`array_axis_vcs ` +example of VUnit's repo. + +VUnit's array_axis_vcs example +****************************** + +:ghsrc:`AXI4Stream/test/vunit/*.vhd ` are regular VUnit testbenches using VUnit's +Verification Components (VCs), similar to the ones found in :gh:`VUnit/vunit: examples/vhdl/array_axis_vcs `. +However, several variants were added here, for testing performance with different setups. + +VUnit +===== + +:ghsrc:`AXI4Stream/test/vunit/run.py ` is a regular VUnit script based on +:gh:`VUnit/vunit: examples/vhdl/array_axis_vcs/run.py `. +It searches the testbenches in the same directory, and executes the tests as usual in a VUnit run. + +This is ``test_AXI4Stream_VUnit`` in CI. + +With pyCAPI +----------- + +:ghsrc:`AXI4Stream/test/vunit/run_capi.py ` is a variant of the default script, which +uses :ref:`API:Core` for retrieving the filesets. +Testbenches are found and executed as usual. + +This is ``test_AXI4Stream_VUnitCAPI`` in CI. + +OSVVM TBStream +************** + +:ghsrc:`AXI4Stream/test/osvvm ` contains VHDL sources based on OSVVM's AXI4 Stream testbench +example: :gh:`OSVVM/AXI4: AxiStream `. + +OSVVM ``.pro`` files +==================== + +OSVVM provides a compilation and execution infrastructure through files with extension ``.pro``, which are in fact TCL +scripts. +Those scripts are used in the CI workflow of :gh:`osvvm/OsvvmLibraries `. + +:ghsrc:`AXI4Stream/test/osvvm/run.pro ` sources OSVVM's scripts and uses the ``analyze`` +``simulate`` commands provided by those. + +This is ``test_AXI4Stream_OSVVM_ProFiles`` in CI. + +GHDL's vendor scripts +===================== + +Maintainers of GHDL provide helper scripts to build vendor libraries, including Xilinx, Intel/Altera,... and OSVVM +(see :gh:`ghdl/ghdl: scripts/vendors `). +Currently, Bash and PowerShell variants of the scripts are provided. +Those scripts are used in the CI workflow of :gh:`ghdl/extended-tests`. + +.. HINT:: + GHDL's vendor scripts are typically used along with custom simulation scripts or with VUnit. + Is it possible to use them for compilation and OSVVM's ``.pro`` files for running the simulations? + +VUnit +===== + +Since VUnit allows managing the compilation of VHDL sources or adding externally built libraries, there are multiple +possibilities for combining the OSVVM methodology and the VUnit framework. +Ten different use cases are showcased in this repository, nine of which are summarised in the following table: + +======================== ========================================================== ========================================================================== ============================================================================ +Order \\ Build procedure RunScript ProFiles VendorScripts +======================== ========================================================== ========================================================================== ============================================================================ +Without VUnit's VCs :ghsrc:`run.py ` :ghsrc:`run_ext_pro.py ` :ghsrc:`run_ext_ghdl.py ` +With VUnit's VCs Before :ghsrc:`run_wvcsb.py ` :ghsrc:`run_ext_pro_wvcsb.py ` :ghsrc:`run_ext_ghdl_wvcsb.py ` +With VUnit's VCs After :ghsrc:`run_wvcsa.py ` :ghsrc:`run_ext_pro_wvcsa.py ` :ghsrc:`run_ext_ghdl_wvcsa.py ` +======================== ========================================================== ========================================================================== ============================================================================ + +where: + +* ``RunScript``: compiling sources through VUnit. +* ``ProFiles``: using OSVVM's ``.pro`` files for building OSVVMLibraries, and then adding them as external to VUnit. +* ``VendorScripts``: using GHDL's vendor scripts for building OSVVMLibraries, and then adding them as external to + VUnit. + +and: + +* ``Before``: VUnit's ``add_verification_components`` (including the builtin OSVVM) is used before adding non-builtin + OSVVMLibraries. +* ``After``: non-builtin OSVVM and/or OSVVMLibraries are added before using VUnit's ``add_verification_components``. + +Moreover, :ghsrc:`run_wvcsans.py ` is equivalent to ``run_wvcsb.py``, but the +resources are added in a different order. + +The corresponding tests in CI are the following: + +* ``test_AXI4Stream_OSVVM_VUnit`` +* ``test_AXI4Stream_OSVVM_VUnit_WithVCsBefore`` +* ``test_AXI4Stream_OSVVM_VUnit_WithVCsAfter`` +* ``test_AXI4Stream_OSVVM_VUnit_WithVCsAfterNoSkip`` +* ``test_AXI4Stream_OSVVM_VUnit_external_ProFiles`` +* ``test_AXI4Stream_OSVVM_VUnit_external_ProFiles_WithVCsBefore`` +* ``test_AXI4Stream_OSVVM_VUnit_external_ProFiles_WithVCsAfter`` +* ``test_AXI4Stream_OSVVM_VUnit_external_VendorScripts`` +* ``test_AXI4Stream_OSVVM_VUnit_external_VendorScripts_WithVCsBefore`` +* ``test_AXI4Stream_OSVVM_VUnit_external_VendorScripts_WithVCsAfter`` + +With pyEDAA.ProjectModel +------------------------ + +:ref:`edaa:Concept` + +*TBC* + +.. HINT:: + Probably, use GHDL's :gh:`compile-osvvm.ps1 ` as a + reference or for generating ``*.core`` files automatically. diff --git a/_sources/egs/sff.rst.txt b/_sources/egs/sff.rst.txt new file mode 100644 index 0000000..feed8d8 --- /dev/null +++ b/_sources/egs/sff.rst.txt @@ -0,0 +1,17 @@ +.. _Examples:SFF: + +Simple Flip-Flop +################ + +This is an as-simple-as-possible UUT for investigating how to enhance the integration of frameworks with conflicting test +management features. + +.. _Examples:SFF:VUnit-cocotb: + +VUnit and cocotb +================ + +See :ghsrc:`SFF/README.md ` for a discussion about how to integrate VUnit and cocotb. +The content of :ghsrc:`SFF/test ` is based on :gh:`ktbarrett/vunit-cocotb`. + +See also :gh:`jwprice100/vcst: VUnit and Cocotb Smashed Together `. diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt new file mode 100644 index 0000000..0a9040f --- /dev/null +++ b/_sources/index.rst.txt @@ -0,0 +1,112 @@ +.. _OSVB: + +.. |shieldosvb| image:: https://img.shields.io/badge/OSVB-d3a64f.svg?longCache=true&style=flat-square&logo=github +.. _shieldosvb: https://github.com/umarcor/osvb + +.. |shieldcocotb| image:: https://img.shields.io/badge/cocotb-77a037.svg?longCache=true&style=flat-square&logo=github +.. _shieldcocotb: https://hdl.github.io/awesome/items/cocotb/ + +.. |shieldOSVVM| image:: https://img.shields.io/badge/OSVVM-f9ca47.svg?longCache=true&style=flat-square&logo=github&logoColor=000 +.. _shieldOSVVM: https://hdl.github.io/awesome/items/osvvm/ + +.. |shieldSVUnit| image:: https://img.shields.io/badge/SVUnit-488d26.svg?longCache=true&style=flat-square&logo=github +.. _shieldSVUnit: https://hdl.github.io/awesome/items/svunit/ + +.. |shieldUVVM| image:: https://img.shields.io/badge/UVVM-fe9932.svg?longCache=true&style=flat-square&logo=github +.. _shieldUVVM: https://hdl.github.io/awesome/items/uvvm/ + +.. |shieldVUnit| image:: https://img.shields.io/badge/VUnit-0c479d.svg?longCache=true&style=flat-square&logo=github +.. _shieldVUnit: https://hdl.github.io/awesome/items/vunit/ + +.. |shieldGHDL| image:: https://img.shields.io/badge/GHDL-222222.svg?longCache=true&style=flat-square&logo=github +.. _shieldGHDL: https://hdl.github.io/awesome/items/ghdl/ + +.. |shieldIVerilog| image:: https://img.shields.io/badge/Icarus%20Verilog-f33b48.svg?longCache=true&style=flat-square&logo=github +.. _shieldIVerilog: https://hdl.github.io/awesome/items/iverilog/ + +.. |shieldVerilator| image:: https://img.shields.io/badge/Verilator-128fd2.svg?longCache=true&style=flat-square&logo=github +.. _shieldVerilator: https://hdl.github.io/awesome/items/verilator/ + +.. |shieldYosys| image:: https://img.shields.io/badge/Yosys-da3390.svg?longCache=true&style=flat-square&logo=github +.. _shieldYosys: https://hdl.github.io/awesome/items/yosys/ + +.. only:: html + + .. centered:: |shieldosvb|_ · |shieldcocotb|_ |shieldOSVVM|_ |shieldSVUnit|_ |shieldUVVM|_ |shieldVUnit|_ · |shieldGHDL|_ |shieldIVerilog|_ |shieldVerilator|_ |shieldYosys|_ + + ---- + +Open Source Verification Bundle +############################### + +Welcome to the Documentation of the Open Source Verification Bundle (OSVB)! + +OSVB gathers the :web:`most popular ` open source verification :ref:`Projects` for +VHDL and System Verilog: +:awesome:`CoCoTb `, +:awesome:`OSVVM `, +:awesome:`SVUnit `, +:awesome:`UVVM `, +:awesome:`VUnit `. +Each of them was created and is maintained by different groups of people, in different contexts and with different +backgrounds. +All evolved into standalonish solutions involving build and test execution helpers, along with verification components +for standard interfaces. +However, each project prioritised certain features, while others didn't receive so much care. +The purpose of this bundle is twofold: + +* Allow users of any of the frameworks/methodologies to share some plumbing with others, so that communities can share + testbenches written in any framework without having to learn a new workflow from scratch. +* Reduce the maintenance burden of the projects by focusing on the features which are unique to a particular + framework/methodology, instead of reinventing the wheel. + +All the frameworks support multiple vendor tools as well as open source simulators. +However, due to licensing restrictions, it is not possible to test non FLOSS simulators on public Continuous Integration +(CI) services. +Therefore, the examples in this bundle are tested on CI with open source simulators/compilers only (see :ref:`Simulators`). + +.. IMPORTANT:: + This project is a proof of concept for gathering several integration efforts involving the target projects by pairs. + For instance, VUnit and cocotb, or VUnit and OSVVM. + Not all the features described in this home page are implemented yet. + See the available examples for an specific reference about what is ready to be used. + +.. toctree:: + :caption: Introduction + :hidden: + + intro/index + intro/frameworks + intro/sim + intro/cosim + EDA² Conceptual Model ➚ + +.. toctree:: + :caption: API + :hidden: + + apis/core + apis/project + apis/tool + apis/runner + apis/logging + +.. toctree:: + :caption: Examples + :hidden: + + egs/sff + egs/axi4stream + +.. toctree:: + :caption: Notebook + :hidden: + + notebook/fpconv + notebook/sigrok + +.. toctree:: + :caption: Appendix + :hidden: + + references diff --git a/_sources/intro/cosim.rst.txt b/_sources/intro/cosim.rst.txt new file mode 100644 index 0000000..dda7739 --- /dev/null +++ b/_sources/intro/cosim.rst.txt @@ -0,0 +1,108 @@ +.. _Co-simulation: + +Co-simulation +############# + +Advanced verification strategies do typically raise the abstraction level of the workflow, bringing hardware design close +to software development. In this context, engineers have a natural trend towards using more flexible languages with vast +libraries implementing advanced domain-specific functionalities. Some of the most common non-HDL languages used for +verification are C/C++ and Python. + +Standard interfaces +=================== + +Traditional HDL languages and most simulators support one or multiple standard or non-standard co-simulation interfaces for +runtime interaction between HDLs and software languages (typically C/C++, as a reference). Here, standard interfaces are +summarized. + +.. IMPORTANT:: + Licensing constraints of many vendor tools do not allow discussing features and/or perfomance publicly. Therefore, this + section contains references to interfaces supported by open source tools only, which don't have such knowledge limitations. + +VPI +--- + +Verilog Procedural Interface (VPI) is the standard co-simulation interface in Verilog 2005. It was originally known +as PLI 2.0, because it replaced the deprecated Program Language Interface (PLI) defined in earlier versions of the language. + +The usage of VPI is based on registering callbacks at specific events using the provided C API. C functions can also invoke +standard verilog system tasks. A relevant feature of this co-simulation approach is that HDL sources are unmodified. Registering +co-simulation callbacks is independent from the sources that compose the design and/or the HDL testbench. + +* :web:`I Spy with My VPI: Monitoring signals by name, for the UVM register package and more ` + +.. NOTE:: + Non-intuitively, GHDL implements VPI for interacting with VHDL sources. Back in 2000-2008, there was no standard interface + available for VHDL, so the author of GHDL implemented VPI for allowing co-simulation. + +DPI +--- + +Direct Programming Interface (DPI) is an standard co-simulation interface defined in System Verilog. It is mainly meant for +co-simulation with C, C++ or SystemC. However, unlike VPI, setting up a DPI co-simulation consists of two layers. On the one +hand, the resources to be used with foreign languages are explicitly declared in the System Verilog sources. On the other hand, +sources in a foreign language provide the complementary bodies that match the prototypes of the resources declared in the first +layer. In other words, DPI allows users/developers to define custom APIs between System Verilog and foreign languages that +understand C/C++ semantics. + +VHPI +---- + +VHDL Procedural Interface (VHPI) is the standard co-simulation interface in VHDL 2008 and VHDL 2019. It is heavily inspired +on VPI, so the workflow/usage is equivalent: a C/C++ API allows registering callbacks and models, without modifying HDL sources. + +The definition and descriptions of VHPI are software-centric, i.e. mostly meant for complex software tool developers having +access to the full HDL hierarchy from an advanced software API. It is, therefore, a very powerful API with a very steep learning +curve. As a result, adoption by vendors has been slow and uneven. At the same time, there was not a critical mass of VHDL use +cases, and the apparent lack of interest from users didn't push vendors further. + +VFFI/VDPI +--------- + +Back in 2005-2006, the author of GHDL implemented a co-simulation feature named VHPIDIRECT. It is, essentially, a Foreign +Function Interface (FFI) for executing foreign subprograms from VHDL. Function/procedure prototypes are declared in VHDL with +an specific ``FOREIGN`` attribute. Matching foreign (C/C++) bodies can be provided through pre-built shared libraries and/or +as C sources/objects to be used during elaboration/linking. + +The implementation of VHPIDIRECT in GHDL was inspired on some draft of VHPI, which was apparently modified before making it +into the VHDL 2008 standard. As a result, although the VHPIDIRECT is used/defined in the LRM, GHDL's implementation is not +compliant. Precisely, the standard requires some specific intermediate structs (fat pointers) to be used between VHDL and +the foreign langauge; however, GHDL's implementation passes arguments directly (by value or by reference). + +It is rather obvious that System Verilog's DPI resembles GHDL's VHPIDIRECT just as much as VHPI was inpired by VPI. In 2011, +a Language Change Specification (LCS) proposal was submitted for VHDL 201X to support a DPI. It didn't make it due to the +workload in the VHDL Analysis and Standardization Group (VASG). However, since Q2 2020, the VASG is working on gathering +and updating a proposal for standardizing an interface named VHDL Foreign Function Interface (VFFI) or VHDL Direct Programming +Interface (VDPI), which formalizes the direct implementation available in GHDL and makes it generic enough for any vendor. + +* :gl:`gitlab.com/IEEE-P1076/VHDL-Issues: Direct Programming Interface (DPI) | Foreign Function Interface (FFI) ` + +Remote procedure calls +====================== + +Typically, simulators expect to be the root and managers of the execution. Therefore, although setting callbacks and/or +foreign function calls is possible through any of the standard interfaces, actually co-executing simulations with +arbitray software threads is not trivial. As a result, several proposals exist for binding standard interfaces to some +Remote Procedure Call (RPC) library, for decoupling the execution kernels of multiple tools. + +gRPC +---- + +* :web:`grpc.io` (:gh:`grpc`) +* :gh:`dbhi/gRPC` + +capnproto +--------- + +* :web:`capnproto.org` (:gh:`capnproto`) +* :gh:`NyanCAD` + + * :gh:`CxxrtlSimServer ` + * :gh:`XyceSimServer ` + * :gh:`NgspiceSimServer ` + +ZeroMQ +------ + +* :web:`zeromq.org` (:gh:`zeromq`) +* :web:`VZMQ - ZeroMQ communication with VHDL simulation in GHDL ` diff --git a/_sources/intro/frameworks.rst.txt b/_sources/intro/frameworks.rst.txt new file mode 100644 index 0000000..79d471d --- /dev/null +++ b/_sources/intro/frameworks.rst.txt @@ -0,0 +1,257 @@ +.. _Projects: + +Frameworks and Methodologies +############################ + +cocotb +====== + +Cocotb is a coroutine based co-simulation library for writing VHDL and Verilog testbenches in Python. +It was initially written and open sourced by :web:`Potential Ventures ` in 2013. +The project went dead for some months between 2017 and 2018. +Since 2019, it is maintained by members of the :web:`FOSSI Foundation ` and other +contributors. + +Cocotb provides shared libraries written in C++, which allows simulators to load Python scripts and interact with them +at runtime through indirect co-simulation interfaces: VPI, VHPI or FLI (see :ref:`Co-simulation`). +Therefore, users can write testbenches for existing HDL designs using Python only. +Direct interfaces such as DPI or CXXRTL are not supported. + +The provided compile and execution plumbing is based on Makefiles and environment variables. +That is loved by some users and hated by others. +There is work in progress for providing alternative build/execution workflows, without explicitly forcing users to use +an specific approach. +Using VUnit's simulator interface is one of such alternatives, which would provide a Python based solution to the most +pythonic cocotb users. + +Cocotb provides logging features based on Python's ``logging`` library. +Integration of this logging approach into VUnit's Python runner is not straightforward. +Since cocotb's co-simulation scripts are loaded by the simulator in an independent instance of Python, neither VUnit nor +cocotb are explicitly aware of the other Python instance. +Moreover, different versions of Python might be used. +Anyway, simulations can be successfully executed and logs from both frameworks are usable. + +There are some test management features included in cocotb. +Those allow running multiple tests with a single call/execution, instead of requiring a call for each test. +However, this feature is not as well implemented/tested as the codebase related to co-simulation. +There are different sensibilities about preserving this feature in the bundle, or removing it in favour of VUnit's +runner interface. + +The list of simulators supported by cocotb is longer than the ones supported by VUnit (see :ref:`cocotb:simulator-support` +and :ref:`vunit:installing`). +The most notable difference is that cocotb supports iverilog and verilator, while the only open source simulator +supported by VUnit is GHDL. +Therefore, usage of this bundle with open source simulators is limited to VHDL designs at the moment. +Nevertheless, there is interest in evaluating again whether iverilog's improved System Verilog support can suffice for +VUnit. + +* :gh:`cocotb/cocotb` +* :gh:`themperek/cocotb-test` +* :gh:`ktbarrett/pyvertb` + +.. TIP:: + Compared to other frameworks, the cocotb ecosystem is more distributed. + Others have most of the resources gathered in single GitHub repository. + Conversely, there is much activity around cocotb in repositories outside of the main repository. + + * :gh:`aignacio/ravenoc: tb ` + +.. NOTE:: + :gh:`benbr8/rstb` is an alternative implementation of the same approach, using Rust instead of Python. + +hgdb +==== + +*TBC* + +* :gh:`Kuree/hgdb` +* :gh:`Kuree/pysv` + +OSVVM +===== + +OSVVM provides an ASIC level verification methodology for VHDL that can be used on small FPGA projects. +The HDL libraries and utilities were initially provided by Jim Lewis as a learning resource in +:web:`SynthWorks `' training courses, for attendants to see the concepts applied. +In 2019 the libraries were uploaded to GitHub, and in 2020 the license was changed to Apache, since it was accepted as a +pilot program for IEEE Open Source. + +The OSVVM utility library offers capabilities similar to those provided by other verification languages (such as +SystemVerilog and UVM): + +* Transaction-Level Modeling +* Constrained Random test generation +* Functional Coverage with hooks for UCIS coverage database integration +* Intelligent Coverage Random test generation +* Utilities for testbench process synchronization generation +* Utilities for clock and reset generation +* Transcript files +* Error logging and reporting - Alerts and Affirmations +* Message filtering - Logs +* Scoreboards and FIFOs (data structures for verification) +* Memory models + +The OSVVM model library provides the verification components for AXI4, AXI4 Lite, AXI4 Stream and UART. + +The provided compile and execution plumbing is written in TCL, since it is mostly meant to be used interactively inside +the built-in shell in most vendor simulators. +Alternative installation scripts are provided by maintainers of GHDL through their :gh:`vendor scripts `. +However, those are for GHDL only, not for any simulator. + +Many HDL utilities are duplicated between OSVVM and VUnit. +Nevertheless, the philosophy of both projects is different, and not necessarily conflictive. +OSVVM uses the most modern features of the language for achieving nicest looking descriptions for making advanced +features approachable. +As a result, it is on the bleeding-edge of the features that simulators do support. +Conversely, VUnit has a more conservative philosophy and tries to support the widest range of simulators, avoiding the +most recent and not broadly supported features. + +Some years ago, maintainers of OSVVM and VUnit did try isolating some common HDL libraries that both projects could use +for e.g. logging features. +It didn't work back then, but there is interest in maybe trying it again in the future. +Nevertheless, having duplicated features is not an issue in the context of this bundle, since it allows each user to +pick their preferred approach. + +The main stopper for using VUnit's Python features for running OSVVM's tests is that the primary unit in OSVVM's +methodology are VHDL configurations, and VUnit only supports entities as primary units. +There is common interest in hopefully extending VUnit and supporting configurations as entrypoints. + +* :gh:`OSVVM/OSVVM` +* :gh:`OSVVM/OsvvmLibraries` +* :gh:`OSVVM/OSVVM-Scripts` +* :gh:`ghdl/ghdl: scripts/vendors ` + + * :gh:`ghdl/extended-tests ` + +Renode +====== + +Renode (developed by :web:`Antmicro `) is not an HDL testing/verification framework per se. +It is presented as a development framework for accelerating IoT and embedded systems development by simulating physical +hardware systems (including the CPU, peripherals, sensors, environment and wire or wireless medium between nodes). +Precisely, in the context of IoT and embedded system, software and wire(less) communication play a crucial role in +Renode. +It allows running, debugging and testing unmodified embedded software on a workstation or laptop. + +However, simulation models for custom hardware and in-development CPUs are not always available. +Moreover, it is sometimes desirable to have bit-accurate and cycle-accurate simulation models for testing custom +accelerators along with well-known CPUs and other peripherals. +As a result, there is work in progress for supporting HDL models to be added as nodes into the Renode infrastructure. +All cosimulation strategies explained in :ref:`Co-simulation` are subject to be integrated, either using existing +Verification Components (VCs) or with ad-hoc middleware. +Find a sample about how to integrate *verilated* models in :gh:`antmicro/renode-verilator-integration `. +It supports a verilated bus master and AXI4. + +* :web:`Renode ` + + * :web:`Using Renode for education, research and demonstration ` + +.. NOTE:: + :gh:`dbhi/vboard` includes multiple references about "*Virtual development board for HDL design*". + Most of those are ad-hoc solutions, which are lacking the *project management* layer for making them plug and play. + However, some of them implement interfaces or HDL languages which are not supported in Renode yet. + +SVUnit +====== + +*TBC* + +* :gh:`tudortimi/svunit` +* :gh:`dpretet/svut` + +UVM +=== + +Universal Verification Methodology (UVM) is a standardized methodology for verifying ASIC designs. +The main implementation of UVM is available in SystemVerilog only. +Unfortunately, no open source simulator supports enough of SystemVerilog for using UVM. +At the same time, vendors don't typically support UVM in their low-end license tiers. +Therefore, although it is probably the most used methodology by ASIC designers and large companies, usage by small and +middle companies, academics, hackers and hobbyist is less significant. + +Lately, several alternatives were proposed for implementing UVM in languages other than SystemVerilog. +For instance, even though iverilog cannot execute UVM in SystemVerilog, there are two projects for using UVM with +iverilog through cocotb: + +* :gh:`tpoikela/uvm-python` +* :gh:`pyuvm/pyuvm` + + * :gh:`pyuvm: The Python version of the UVM (cocotb/cocotb#2418) ` + * :web:`siemens.com/verificationhorizons: Cocotb Bus Functional Models ` + +.. NOTE:: Lately, it seems that uvm-python is being merged into pyuvm. + +Similarly, there is a C/C++ implementation, which uses DPI, VPI, VHPI or FLI for interacting with the RTL code: :web:`uvm.io`. + +Furthermore, there work in progress for adding System Verilog support to verilator, including both synthesizable and +non-synthesizable constructs. See :ref:`Simulators:Verilator`. + +UVVM +==== + +*TBC* + +* :gh:`UVVM ` + +VUnit +===== + +VUnit is an open source unit testing framework for VHDL/SystemVerilog. +It was developed and maintained by Lars Asplund and Olof Kraigher and it was initially released in 2015. +Several users contributed and maintain verification components. +Unai Martinez-Corral contributed co-simulation features to be used with GHDL's implementation of VHPIDIRECT (see +:ref:`Co-simulation`). + +The main focus of VUnit is providing the functionality needed to realize continuous and automated testing of HDL code. +It provides a Python API for declaring sources and library names, for parameterizing tests and for defining simulator +execution parameters. +The simulator interface is coupled with a test runner implemented both in Python and in HDL. +That allows hardware designers to define tests in HDL, thus, complementing traditional HDL only testing methodologies. +It brings multiple concepts for Test Driven Design (TDD) from software into the hardware design. + +Optional HDL libraries include utilities for checks, logging, handling arrays, randomization, etc. as well as a +communication package for modelling abstract messaging channels. +Verification components for several standard interfaces are provided based on the communication package. +Custom types are also provided for allowing dynamic allocation of pointers (accesses). + +VUnit includes the core of OSVVM as a submodule. +It also includes :gh:`JSON-for-VHDL `, which allows passing arbitrarily complex generics to +the testbenches, by providing them as encoded JSON strings. + +Using the OSVVM Libraries and UVVM with VUnit is possible but not straightforward. +In VUnit, libraries and sources are declared in a Python script, using VUnit's API. +Users have three options: + +* Manually declaring which sources belong to each library, in the Python run script. +* Using the TCL scripts provided by OSVVM/UVVM for pre-compiling the frameworks, and then provide the locations to the + pre-built sources in the Python script. +* Using GHDL's vendor scripts for pre-compiling the frameworks, and then provide the locations by passing + :option:`-P ` to GHDL in the Python script. + +None of them is ideal. +The first one requires all users to repeat some code which might be easily reused. +Others require dealing with paths/locations specific to each host/system. +Instead, the approach in this bundle uses ``*.core`` files and :ref:`API:Core`. + +With regard to simulator support, VUnit does currently not support any open source Verilog or System Verilog simulator. +However, it was last evaluated 3-4 years ago (see :gh:`VUnit/vunit#188 `). +Since both iverilog and iverilog were improved, and specially System Verilog support, it might be possible to use them +with VUnit nowadays. + +* :gh:`VUnit/vunit` +* :gh:`VUnit/vunit_action` +* :gh:`VUnit/tdd-intro` +* :gh:`VUnit/cosim` + +.. NOTE:: + :gh:`Malcolmnixon/VhdlTest ` is a proof of concept of a minimal implementation of the + Python runner in VUnit. + It's for VHDL testbenches only, and supports GHDL or Active-HDL. + It requires a YAML configuration file for specifying the project, instead of using a Python script. + This feature is related to :ref:`API:Core`. + +Learning/teaching +================= + +* :web:`Course content for the Design Verification module at the University of Bristol ` +* :gh:`umarcor: references/VHDL.bib ` diff --git a/_sources/intro/index.rst.txt b/_sources/intro/index.rst.txt new file mode 100644 index 0000000..a0a505e --- /dev/null +++ b/_sources/intro/index.rst.txt @@ -0,0 +1,72 @@ +.. _Overview: + +Overview +======== + +The block diagram below illustrates how the components fit together in this bundle: + +.. figure:: ../_static/osvb.png + :alt: Block diagram of the OSVB + :width: 100% + :align: center + + Block diagram of the Open Source Verification Bundle. + +The language of choice for integration is Python. +Some verification projects do use Python already; others provide scripts written in TCL, Perl or Bash. +However, the wider open source ecosystem for hardware design is dominated by Python. +It's the fastest growing language in many fields, and specially in the embedded world. + +Among the frameworks providing a Python based simulator interface and test management plumbing, VUnit's solution is the +most mature and feature complete. +It does also provide a neat integration between Python and top-level testbenches, allowing hardware designers to define +multiple test cases in HDL, but have them handled from Python. +Therefore, the core of OSVB are VUnit's Python modules. + +cocotb's main feature is providing shared libraries for allowing co-simulation from Python. +Moreover, the Python modules for co-simulation are loaded by the simulator, not by the caller. +Therefore, any simulator interface and task management plumbing for regular HDL designs is suitable for executing +testbenches with cocotb's co-simulation features. +That is the case with VUnit. +However, there is a conflict with the test management features in both frameworks. +Both of them expect to be the root of the management, thus they both finalise individual test/simulations independently. +There is a race between them, and one will always fail. +There is work in progress for letting one of them wait for the other. +See :ref:`Examples:SFF:VUnit-cocotb`. + +OSVVM is composed by a core repository and a larger distribution named *OSVVM Libraries*, which includes verification +components and build/run scripts. +VUnit does include the core as a built-in feature, since randomisation features are based on that. +However, other libraries are not included by default. +The missing repositories might be added as built-in VUnit modules too, but it increases the maintenance burden of VUnit +and it's not an scalable approach. +OSVVM does provide ``*.pro`` files, which uses a custom syntax for defining sources and the compilation order. +Those files are used by OSVVM's own TCL scripts and also by :gh:`GHDL's vendor scripts ` +(written in PowerShell and Bash). +Yet, writing a custom Python module for reading those files doesn't feel worth. +Instead, the proposal in this bundle is to use ``*.core`` (YAML) files. +See :ref:`API:Core`. +Furthermore, the entrypoint to tests based on the OSVVM methodology are VHDL configurations, unlike other methodologies +based on entities. +Currently, VUnit's runner does not support executing configurations as primary units. +However, there is common interest in making it possible. + +Similarly, UVVM is not supported as a built-in feature in VUnit, but ``compile_order.txt`` files are provided. +Those are used by UVVM's own TCL scripts and also by GHDL's vendor scripts (written in PowerShell and Bash). +As with OSVVM, the proposal in this bundle is to use ``*.core`` (YAML) files. See :ref:`API:Core`. + +While VUnit provides multiple optional helper VHDL libraries, the SystemVerilog infrastructure is limited to the HDL +runner and some `check` features. +Conversely, SVUnit is for SystemVerilog mostly. +The test management features in SVUnit are implemented using Perl, and installation scripts are written in bash/csh. +As a result, it would be interesting to handle SVUnit's HDL resources through VUnit's simulator interface and runner. +There is no work in progress in this regard yet. + +Since this bundle is focused on simulation of HDL-centric testbenches, synthesis and formal verification are out of the +scope. +However, most projects are to be implemented in practice, and the sources of Units Under Test (UUTs) are to be used for +both simulation and implementation. +Therefore, the usage of :ref:`API:Core` in this bundle is not limited to adding verification frameworks +and/or methodologies; it is also the proposed solution for users to declare the sources of their designs. +By the same token, :ref:`API:Project`, :ref:`API:Tool`, :ref:`API:Runner` and :ref:`API:Logging` are +also extensible for being used in synthesis and implementation. diff --git a/_sources/intro/sim.rst.txt b/_sources/intro/sim.rst.txt new file mode 100644 index 0000000..fbf063a --- /dev/null +++ b/_sources/intro/sim.rst.txt @@ -0,0 +1,111 @@ +.. _Simulators: + +Simulators | Compilers +###################### + +.. IMPORTANT:: + Licensing constraints of many vendor tools do not allow discussing features and/or perfomance publicly. Therefore, this + section contains references to open source tools only, which don't have such knowledge limitations. + +.. _Simulators:Essent: + +Essent +====== + +*TBC* + +* :gh:`ucsc-vama/essent` + +.. _Simulators:GHDL: + +GHDL +==== + +GHDL is an open source analyzer, compiler, simulator and (experimental) synthesizer for VHDL (87, 93, 02 and 08). It has +partial support for Property Specification Language (PSL), and it can write waveforms to GHW, VCD or FST files. It supports +two co-simulation interfaces: Verilog Procedural Interface (VPI) and VHPIDIRECT (a non VHDL LRM compliant Foreign Function +Interface, which is being standardized as VFFI/VPI). GHDL can generate either executable binaries or shared libraries by +using one of three backends: GCC, LLVM or (x86_64/i386 only) mcode (built-in and in-memory ASM code generator). + +* :gh:`ghdl/ghdl` +* :gh:`ghdl/ghdl-cosim` +* :gh:`ghdl/ghdl-yosys-plugin` +* :gh:`ghdl/ghdl-language-server` +* :gh:`ghdl/setup-ghdl-ci` +* :gh:`ghdl/extended-tests` + +.. _Simulators:IcarusVerilog: + +Icarus Verilog +============== + +Icarus Verilog is an open source analyzer, compiler, simulator and (experimental) synthesizer for all of the Verilog HDL as +described in the IEEE-1364 standards. It supports Verilog Procedural Interface (VPI) for co-simulation. It is mostly used +for simulation of behavioural constructs in complex testbenches. Icarus Verilog can write waveforms to VCD, LXS2 or FST files. + +* :gh:`steveicarus/iverilog` +* :gh:`steveicarus/ivtest` + +.. _Simulators:NVC: + +NVC +=== + +*TBC* + +* :gh:`nickg/nvc` +* :web:`nickg.me.uk/nvc` + +.. _Simulators:Verilator: + +Verilator +========= + +Verilator is an open source analyzer and simulator for the synthesizable subsets of Verilog and SystemVerilog. +It compiles HDL sources into multithreaded C++ or SystemC, providing high-performance for large synthesizable designs. +The *verilated* model is then compiled by a C++ compiler (GCC, clang, MSVC++...), allowing generation of standalone +binaries or shared libraries, together with a user defined wrapper. +Verilator can write waveforms to VCD or FST files. +Language support is limited compared to iverilog, but it provides much faster simulation as well as implicit +obfuscation. + +* :gh:`verilator/verilator` +* :gh:`verilator/verilator_ext_tests` +* :gh:`verilator/example-systemverilog` + +Although verilator does not support enough of System Verilog for using UVM yet, there is work in progress for achieving +it. +Apart from supporting System Verilog for synthesis through :awesome:`Surelog ` +and :awesome:`UHDM `, :web:`CHIPS Alliance ` members +:web:`Antmicro `, :web:`Western Digital ` and :web:`Google ` +are working on *verilating* non-synthesizable code, to allow running System Verilog UVM with Verilator. +See: + +* :web:`Enabling open source Ibex synthesis and simulation in Verilator/Yosys via UHDM/Surelog ` + +* :gh:`verilator/uvm ` + + * :gh:`SymbiFlow/sv-tests ` + +* :web:`Dynamic scheduling in Verilator - milestone towards open source UVM ` + + * :gh:`antmicro/verilator-dynamic-scheduler-examples` + * :web:`CHIPS Alliance Deep Dive Cafe Talks Jun 15, 2021 ` + ( + :youtube:`Video `, + :web:`Slides ` + ) + +.. _Simulators:CXXRTL: + +Yosys/CXXRTL +============ + +Yosys is an open source framework for RTL synthesis tools. It has built-in Verilog 2005 support, and can process VHDL using +GHDL as a frontend (through ghdl-yosys-plugin). Yosys is written in C++ and it has a built-in simulation backed named CXXRTL. +Similarly to Verilator, CXXRTL writes out the post-synthesis netlist as a set of C++ classes. Then, a user defined wrapper +instantiates the design, toggles the clock and interacts with the ports. CXXRTL can write waveforms to VCD files. It supports +providing black boxes as behavioural C++ models, similarly to some standard co-simulation interfaces. + +* :gh:`YosysHQ/yosys` +* :gh:`tomverbeure/cxxrtl_eval` diff --git a/_sources/notebook/fpconv.rst.txt b/_sources/notebook/fpconv.rst.txt new file mode 100644 index 0000000..cf0eafc --- /dev/null +++ b/_sources/notebook/fpconv.rst.txt @@ -0,0 +1,310 @@ +.. _Notebook:fpconv: + +Fixed-point conversion +###################### + +This section contains notes about data type exploration and visualization in arithmetic algorithms/circuits. Approaches +based on HDL and programming languages are discussed. + +Porting algorithms involving intensive arithmetic pipelines/sequences from a high-level software language to a Hardware +Description Language (HDL) is non-trivial. On the one hand, data storage and movement need to be redesigned, in order to +make the most of available resources on the target devices. On the other hand, reducing area and power constraints by +using custom precision fixed-point data types is a usual strategy. + +Traditionally, data type analysis and modeling is done in software. A typical procedure is to: + +1. Write an algorithm with double precision. +2. Change to single, and compare. +3. Do analytical analysis of propagation of error, if possible; otherwise, do experimental analysis. +4. Change to custom fixed-point types using some library, and compare. +5. Write/generate (V)HDL with `std_logic_vector`, `unsigned` and/or `signed`, and compare. + +Multiple tools/frameworks/languages provide features for modelling fixed-point data types in step 4 (e.g. +:web:`rig ` on :web:`Python `, +:web:`fixed_point_format ` on :web:`Octave `, +or :web:`fixed ` on :web:`Rust `, +or :gh:`shopspring/decimal` on :web:`golang `). +However, none of the mentioned resources was originally designed for modelling fixed-point circuits, even less *custom* +types. +Furthermore, the structure/layout of software sources can be significantly different from hardware description sources. +As a result, users/developers need to duplicate the effort for avoiding mismatches between simulation models and circuit +descriptions. + +Several HDL generation tools avoid effort duplication by *allowing* developers not to write HDL (step 5). +This is the case of :web:`Xilinx `'s :web:`Vivado HLS ` +and :web:`Vitis `, :web:`MyHDL ` or +:web:`migen `, among others. +For example, :web:`MathWorks `' :web:`MATLAB ` and +:web:`Simulink ` provide multiple features to do so: + +* :web:`mathworks.com/products/fixed-point-designer ` +* :web:`mathworks.com/videos/data-type-exploration-and-visualization-of-signal-ranges-1506620567017.html` +* :web:`mathworks.com/help/fixedpoint ` + + * :web:`ref/numerictypescope.html ` + * :web:`ug/configuring-blocks-with-fixed-point-output.html ` + * :web:`ug/fixed-point-conversion.html ` + +MathWorks' is a comprehensive solution that allows users to run target functions/designs with multiple data sets and to +gather statistics about the value of each variable (step 3). +Then, it suggests lower precision datatypes automatically. +It allows to customize them and to test them iteratively (step 4). +Custom data types or arbitrary sizes and with various encondings are supported (see :web:`fimath `). +Overall, it's a very effective solution when used along with :web:`Coder ` +and/or :web:`HDL Coder ` (step 5). + +However, using higher-level HDL generators comes with its own caveats, such as being constrained by unidiomatic +constructs or not being able to customize/optimize lower level details. +Users familiar with VHDL (or who are otherwise targeting FPGA or ASIC designs) might find using VHDL early in the +algorithmic refinement process to be a suitable alternative. +VHDL's strong type system (inherited from Ada) and the inherent concurrency in the language provide powerful features +for building complex models. + +Since VHDL 2008, IEEE libraries (distributed along with the IEEE 1076 standard) include generic fixed-point and +floating-point packages that allow to define custom data types and rounding/truncation/resizing strategies. +Furthermore, since December 2019 those libraries are open source: :web:`opensource.ieee.org/vasg/Packages `. +For backwards compatibility, the original proponent's (David W. Bishop's) VHDL 1993 versions are available at :gh:`FPHDL/fphdl `. + +Performance-wise, simulation of VHDL designs can be significantly slower than executing other (software) languages. +Fortunately, :gh:`GHDL ` is a *libre* and *gratis* tool, which runs on multiple platforms +(architectures and OSs), and allows to generate executable machine code. +The generated code can be executed standalone or co-executed with sources written in a *foreign* language +(see :web:`ghdl.github.io/ghdl-cosim `). + +This section gathers strategies and code examples about using VHDL and GHDL for getting statistics from +variables/signals in algorithms written using a higher abstraction level VHDL style (step 3). +The purpose is to replace step 2 with porting the code to VHDL. +Then, do steps 3 and 4 with VHDL, and rewrite step 5 as *"converting non-synthesizable sources into a synthesizable description*". + +Initial code porting +******************** + +Although modern VHDL allows writing sources using high abstraction features, those are commonly disregarded when the +language is taught, or even by practitioners. +This is mostly because some (or many) of the higher level features are either not synthesizable or not supported by +synthesis or simulation tools yet. +Moreover, for testing and verification purposes, SystemVerilog and UVM seem to take the lead (see :web:`larsasplund.github.io/github-facts`). + +Nevertheless, many algorithms in fields such as Digital Signal Processing (DSP), image processing or machine-learning +are (or can be) formulated as *basic* vector or matrix operations. +These operations can be described with nested for loops and built-in operators (`+`, `-`, `*`, `/`, `**`), using a +coding style similar to Ada or C. +For example: + +.. code-block:: vhdl + + ... + subtype vec_t is real_vector(0 to d-1); + type mat_t is array(0 to c-1) of vec_t; + begin + process + variable m: mat_t; + variable q: vec_t; + begin + ... + for j in m'range loop + for i in q'range loop + q(i) := q(i) * m(j)(i) when f else q(i) + m(j)(i); + end loop; + end loop; + ... + + +Reading/writing data to/from binary files in VHDL is also similar to other languages: + +.. code-block:: vhdl + + ... + type REAL_BIN is file of real; + file fptr : REAL_BIN; + begin + process + variable sts : FILE_OPEN_STATUS; + variable m: mat_t; + variable q: vec_t; + begin + file_open(sts, fptr, "path/to/input.bin", read_mode); + for j in m'range loop + for i in q'range loop + read(fptr, m(j)(i)); + end loop; + end loop; + file_close(fptr); + ... + +:gh:`JSON-for-VHDL ` is an alternative for more complex data structures. + +Regarding language support, GHDL and some other commercial simulators support enough from VHDL 2008 for using generic +packages and other features that facilitate code reuse. +Unfortunately, most commercial simulator licenses do not allow to disclose whether features are supported. +Hence, users need to check the documentation or test the features themselves. + +Note that rewriting the algorithm in VHDL using `real` data type should not involve any accuracy penalty compared to the +equivalent code in C or m using `double`. + +Getting simulation data +*********************** + +After the algorithm is ported to VHDL and it is validated, analysis of error with reduced precision can be done. +Sometimes, it is possible to obtain a model of propagation of error analytically. +Often, an experimental approach is followed instead. +Assuming availability of enough test data, the algorithm can be simulated to obtain a table that shows the specific +values that each signal/variable was assigned, and how many times was each value used. + +Waveform dumps +============== + +Fortunately, registering all the values that each signal is assigned is a built-in feature in most HDL simulators. +Precisely, waveforms are dumped to formats such as VCD or GHW. +Hence, a possible approach for getting all the values that a signal was assigned is to post-process waveform dumps. + +.. NOTE:: + GHDL allows filtering which signals are dumped (see :option:`--read-wave-opt `). + This allows reducing the size of the dumps by providing the list of signals to be analyzed only. + +vcd_parser +========== + +:gh:`GordonMcGregor/vcd_parser` is a VCD parser that walks through a waveform and allows to set watchers that react +when named signals change. +In 2018, it was forked and updated to be compatible with Python 3: :gh:`wohali/vcd_parsealyze`. +However, neither GordonMcGregor's nor whoali's latest versions seem to handle getting values of multi-bit signals. +:gh:`umarcor/vcd_parsealyze` is a fork of the latter, where reading signals of type `real` or `integer` is supported. +:gh:`fpconv.py ` is an example that watches a clock signal +and saves the values of `real` and `integer` signals at each rising edge. +At the end, the table of each signal is saved to a separate tab-delimited CSV file. + +Currently, reading frequency tables of `real` signals on other tools, such as MATLAB, works as expected. +However, integers are dumped by GHDL as arrays of bits preprended with `b` (32 bits if negative, `<=32` bits if positive). +These are not properly read by other tools yet. +A future enhancement is to sign-extend them before using Python's `eval`, to convert strings to an integer. + +GHDL +==== + +GHDL produces waveform dumps in multiple formats. +Hence, its codebase contains the required logic for achieving the desired purpose. +However, it is not intuitive how to get the name and value of the signals that are being dumped: +:gh:`ghdl/ghdl: src/grt/grt-waves.adb#L1781-L1783 `. + +GtkWave +------- + +By the same token, GtkWave contains C sources that allow reading the waveform formats generated by GHDL. +However, those are not meant to be used as a toolkit (see :gh:`gtkwave/gtkwave#9 `). + +Nevertheless, showing an histogram or table of frequencies might be a handy enhancement to GtkWave's GUI features, for +interacting with fixed-point signals. + +sigrok/PulseView +---------------- + +Although PulseView has some performance issues with waveforms generated by GHDL (see :ref:`Notebook:sigrok`), the +work-in-progress VCD parse module of :gh:`libsigrok ` might have enough features for +achieving the desired purpose. +However, `libsigrok`'s internal structure cannot handle multi-bit signals. + +.. NOTE:: + The interface based on watchers and trackers of `vcd_parsealyze` is very similar to PulseView's concept of protocol + analyzers. + +dwfv +---- + +:gh:`psurply/dwfv` is "*a simple digital waveform viewer (in the therminal) with vi-like key binding*" written in +Rust. +It exposes a backend API to facilitate manipulation of signals in Rust and it provides ``--stats`` through the CLI +interface. +See :gh:`psurply/dwfv#8 `. + +VHDL component/module +===================== + +Instead of using the waveform dumping features provided by simulators, a more granular dumping of signal values is +possible through a reusable VHDL component. +For example: + +.. code-block:: vhdl + + m_stats: entity pkg_name.stats_monitor + generic map ( + target => "path/to/output/file" + ) + port map ( + CLK => clk, + DATA => (a, b, c) + ); + + a <= b + c; + +The module can be implemented with multiple architectures, for generating different output formats (CSV, binary, HEX, +etc.). +A package can provide "dynamically sized arrays of reals" (similar to :gh:`VUnit's integer_array_pkg `). +Alternatively, VPI/VHPI/VHPIDIRECT can be used to pass data through an access/pointer (see :web:`ghdl.github.io/ghdl-cosim`) +by wrapping GHDL in a foreign language. + +The disadvantage of this approach is that additional VHDL code needs to be included in the sources. On the other hand, +it allows to more easily decide which time frames to record and to ignore values under certain conditions. + +This approach is similar to the AXI monitors that are available in :gh:`VUnit` or :gh:`OSVVM`. +The difference is how the content is interpreted. +In AXI monitors, the protocol is checked. +In this use case, a table is filled. + +Simulation/verification frameworks +================================== + +cocotb uses VPI or VHPI interfaces for interacting with simulators at runtime. +It allows to look/watch a hierarchical HDL path (as done in `vcd_parsealyze`). +However, reading nested records and arrays in GHDL through VPI is work in progress yet (see :gh:`ghdl/ghdl#1249 `). + +Analogously, MyHDL allows deriving from the `Signal` class and adding custom hooks/rules. +However, MyHDL's purpose is describing circuits in Python and optionally generating HDL sources. + +* :gh:`Potential replacement for BinaryValue as seen in cocotb ` + +Analyzing simulation statistics +******************************* + +The table of frequencies generated for each recorded signal can be post-processed for generating the histogram in any +language with a plot/graph library (Python, Matlab, Octave, D3.js...). + +Suggesting custom fixed-point formats +************************************* + +Suggesting optimal word size and fractional lengths automatically is out-of-scope of this project. +However, contributions of alternatives to MATLAB's `numerictypescope` that generate an interactive interface are welcome! + +Regarding usage of custom types in VHDL, :gh:`FPHDL · Fixed_ug.pdf ` and +:gh:`FPHDL · Float_ug.pdf ` are the guides of VHDL's packages for defining +custom fixed/float types. +Users familiar with MATLAB's `fimath` will find definition of formats/types and truncation/rounding/overflow strategies +to be almost equivalent. + +Converting sources into a synthesizable description +*************************************************** + +Apart from simulation, GHDL has experimental support for synthesis too (see :ref:`ghdl:USING:Synthesis`). +Hence, after converting data types to fixed-point types (or in parallel with doing it), VHDL sources can be reshaped to +properly describe the structure of the circuit. +During the process, `ghdl --synth` can be used as a check. +When passing, the output of GHDL (which is a VHDL 1993 netlist) can be used in vendor tools (e.g. Vivado). +Alternatively, formal verification is possible through :gh:`ghdl-yosys-plugin `, which plugs +GHDL into the open source ecosystem composed by :awesome:`yosys`, :awesome:`nextpnr`, +:awesome:`SymbiYosys `, etc. + +Examples +******** + +* :gh:`umarcor/vcd_parsealyze: examples/ghdl ` + produces a VCD file to test :gh:`fpconv.py `. +* Example :web:`Array and AXI4 Stream Verification Components ` + from :web:`ghdl.github.io/ghdl-cosim ` shows how to read data of type ``real`` (C's + ``double``) and convert it to/from custom signed fixed-point data types. + +To Do +***** + +* :gh:`smlgit/fpbinary`, a binary fixed point library for Python. +* :gh:`francof2a/fxpmath`, a Python library for fractional fixed-point (base 2) arithmetic and binary manipulation + with Numpy compatibility. diff --git a/_sources/notebook/sigrok.rst.txt b/_sources/notebook/sigrok.rst.txt new file mode 100644 index 0000000..91da5d0 --- /dev/null +++ b/_sources/notebook/sigrok.rst.txt @@ -0,0 +1,212 @@ +.. _Notebook:sigrok: + +sigrok-cli | Pulseview +###################### + +This section contains notes about reading waveforms from HDL simulators with :web:`sigrok-cli ` +and :web:`PulseView ` (see :gh:`sigrokproject`). + +While :gh:`PulseView ` is primarily meant for data captured from real devices (logic +analyzers, oscilloscopes, multimeters, and more), some of its features can be useful for simulation and verification of +hardware description designs. +Precisely, :web:`protocol decoders ` are a nice feature to complement Verification +Components (e.g. Vunit's :web:`VCL `), Bus Functional Models +(BFMs) and/or monitors. +Apart from vendor products, in-house custom protocol decoders can be used as a definition of the internal APIs. +Moreover, analog signal visualization can be useful to show digital words that are meant to be used as inputs to DACs. +Actually, mixed-signal cosimulations (as when combining GHDL and Xyce) produce both digital and analog traces. + +The most widespread waveform format used by EDA tools is VCD: :wikipedia:`Value_change_dump`. +However, not all VHDL types can be represented in VCD files. +:awesome:`GHDL ` supports a format named GHW, which is meant to dump traces from VHDL simulations. +Visualization of any of these types (and others) is supported by :awesome:`GtkWave `. + +The file format that PulseView uses internally is :web:`sigrok.org/wiki/File_format:Sigrok `. +Hence, any other waveform needs to be converted, and possibly filtered. Currently supported input/output formats are +listed at :web:`sigrok.org/wiki/Input_output_formats `. + +Sticking to VCD, several features are (unfortunately) currently missing in :gh:`libsigrok ` +and PulseView: + +* Arrays of signals, i.e. multi-bit signals, are not supported. +* Hierarchy of modules is not preserved. +* By design, signal type is `boolean` (0 or 1). +* They cannot handle huge dumps. While fast and responsive with time resolutions in the order of ms, us or ns, they have + a hard time with ps or fs. These values are uncommon in physical capture devices, but relatively frequent in hardware + modelling. +* Waveform formats other than VCD are not supported. + +Fortunately, there is work in progress by user `gsi`, for improving and extending the VCD frontend in libsigrok. See +`wip/vcd-*` branches in :web:`repo.or.cz/libsigrok/gsi.git/refs`. + +Required enhancements and possible workarounds +============================================== + +Nested signal groups +-------------------- + +Although multi-bit signals are not supported yet, the concept of signal groups exists in PulseView. This is used to +group 1-bit signals that belong to the same interface. Currently, PulseView picks channel groups from file imports other +than VCD or from acquisition device drivers. At the same time, the VCD import frontend of libsigrok can generate nested +channel groups. +Hence, PulseView should pick up and display the groups transparently. The main remaining question is whether the +internal infrastructure of libsigrok supports nested groups. + +Should nested groups be supported, three different types can be generated: + +* level-0: multi-bit signals, i.e. groups of 1-bit signals that can be represented as a binary array, as an + unsigned/signed decimal, as an hexadecimal value, etc. Moreover, any multi-bit signal can be optionally shown as an + analog channel. This is specially useful for fixed-point types (in VHDL, `sfixed` and `ufixed`). For reference, + GtkWave supports almost all of these features; however, displaying fixed-point values as analog channels has some + limitations (see :gh:`gtkwave/gtkwave#9 `). +* level-1 and above: hierarchy of the design, according to the structure of HDL sources. This is described in VCD + through `scope module`. +* within a hierarchy level: nested groups of multi-bit signals would allow to describe interfaces such as Wishbone, AXI, + or Avalon. Hence, protocol decoders could be written and used to display nice labels on top of them. However, this is + typically done through naming conventions, so generation of these groups should probably be handled in PulseView and + not in the VCD frontend. + +The in-progress VCD import frontend can parse scopes and generate signal names with dot separated labels in their names. +This feature can be used to extract the hierarchy for visualization purposes. + +Regarding visualization, it is currently not possible to collapse groups of multi-bit signals (not even level-0 groups). +Ideally, a collapsible tree view or anchors would be shown. + +At the moment, a possible workaround for level-0 groups is to create dummy `integer` or `real` signals in the HDL design, +and convert multi-bit signals (in VHDL, `to_integer` and `to_real` can be used). However, this is not desirable, as it +requires additional coding for each signal to be visualized. + +9-value logic signals +--------------------- + +In hardware description projects, types such as `std_logic` or `std_logic_vector` are very common. These are 9-value +enumeration types, as opposed to `boolean`. Unfortunately, sigrok and PulseView are built around `boolean` values. +Changing it is a non-trivial enhancement that might have many unexpected consequences. + +The in-progress VCD import frontend converts values such as `U` to zero. This allows to import waveforms without +crashing. However, reliability of protocol decoders is doubtful in these contexts. Users should implement alternative +solutions to check the stability and strengh of signals. + +Performance +----------- + +Compared to GtkWave, PulseView has serious issues to handle wavefroms with small time scales. For example, the following +waveform requires several seconds to load: + +.. code-block:: vcd + + $timescale + 1 ps + $end + $scope module tb $end + $var reg 1 ! clk $end + $upscope $end + $enddefinitions $end + #0 + 0! + #1000000000 + 1! + #2000000000 + 0! + #3000000000 + 1! + #4000000000 + 0! + #5000000000 + 1! + +And the following, which is the same wave with a smaller scale, produces a crash: + +.. code-block:: vcd + + $timescale + 1 fs + $end + $scope module tb $end + $var reg 1 ! clk $end + $upscope $end + $enddefinitions $end + #0 + 0! + #1000000000000 + 1! + #2000000000000 + 0! + #3000000000000 + 1! + #4000000000000 + 0! + #5000000000000 + 1! + +More than 9G of RAM are used, it takes minutes to load the first ~50 us, and in the end it is frozen. + +As a workaround, both libsigrok and PulseView allow downsampling when VCD files are imported. It is also possible to +*skip samples until timestamp* or to *compress idle periods*. These features should allow to avoid crashes with +simulations that last milliseconds or seconds with clock frequencies of MHz. + +Moreover, GHDL's *mcode* backend allows to set the base time resolution of the simulation. See +:option:`--time-resolution ` examples in subdir :ghsrc:`sigrok/resolution `. + +Other waveform formats +---------------------- + +In the wiki page about VCD, there are references to other waveform formats supported by GtkWave: +:web:`sigrok.org/wiki/File_format:Vcd `. +However, EVCD, FST, IDX and GHW are not explicitly documented. +Hence, formats other than VCD are unlikely to be supported in libsigrok/PulseView in the near future. +In the mid-long term, it would be nice if PulseView provided a frontend compatible with GtkWave's utils/internals for +handling large waveforms. +It seems that GtkWave implements some clever memory map traversal to avoid handling the entire file in memory. + +Information is available in: + +* :web:`GtkWave User's Guide ` and GtkWave's codebase. +* GHDL's codebase. +* :gh:`nturley/ghw-notes`. + +Generating waveforms with GHDL +============================== + +In this section waveform dump features of GHDL are introduced. This is a complement to the information available in the +docs: :ref:`GHDL:export_waves`. +The purpose of these examples is to provide a test suite that allows users to evaluate the features and performance of +upstream and in-progress branches. + +:ghsrc:`Resolution ` +--------------------------------------- + +GHDL's management of the time resolution during simulation is different depending on the backend. With LLVM or GCC, the +resolution is `1 fs`, and so is the timescale of the resulting VCD files. It cannot be modified, because the time scale +needs to be global. However, with mcode, GHDL automatically adjusts the resolution to the smallest time unit in the +design. Furthermore, CLI option :option:`--time-resolution ` allows to override it. Subdir +:ghsrc:`sigrok/resolution ` contains three testbenches and a shell script to generate 15 waveforms +with different time resolutions (12 with mcode and 3 with LLVM). Each waveform is saved to 5 different file formats, so +75 files are generated. + +======= ============== ==== === +backend design CLI VCD +======= ============== ==== === +mcode ns auto ns +mcode us auto us +mcode ms auto ms +mcode ns or us or ms ps ps +mcode ns or us or ms ns ns +mcode us or ms us us +mcode ms ms ms +LLVM ns or us or ms fs +======= ============== ==== === + +where: + +* backend: used GHDL backend. +* design: smallest time unit in the design. +* CLI: time resolution argument. +* VCD: resulting time scale in the VCD. + +:ghsrc:`Hierarchy ` +------------------------------------- + +libsigrok does currently not support nested name spaces (`module` keyword). This example generates a waveform from a +testbench with an instantiated entity. The waveform includes such `module` keywords. The waveform can be loaded in +PulseView without errors, but all the signals are flattened; so, the hierarchy is lost. diff --git a/_sources/references.rst.txt b/_sources/references.rst.txt new file mode 100644 index 0000000..bcac61f --- /dev/null +++ b/_sources/references.rst.txt @@ -0,0 +1,20 @@ +References +########## + +* `FAQ: What is VUnit's Relation to Other Verification Frameworks? `__ + +* :gh:`umarcor/VHDLNumericUserGuides` + +* :gh:`tmeissner/cocotb_with_ghdl` + +* :gh:`efard/DSPHDL` + +* :gh:`hVHDL` + +* :gh:`microCore-VHDL/microCore` + +* :gh:`raysalemi/Python4RTLVerification` + +* `[hackaday.com] OpenSPICE: A Portable Python Circuit Simulator `__ + +* `[hackaday.com] Create Your RTL Simulations With KiCAD `__ diff --git a/_static/basic.css b/_static/basic.css new file mode 100644 index 0000000..30fee9d --- /dev/null +++ b/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/_static/debug.css b/_static/debug.css new file mode 100644 index 0000000..74d4aec --- /dev/null +++ b/_static/debug.css @@ -0,0 +1,69 @@ +/* + This CSS file should be overridden by the theme authors. It's + meant for debugging and developing the skeleton that this theme provides. +*/ +body { + font-family: -apple-system, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, + "Apple Color Emoji", "Segoe UI Emoji"; + background: lavender; +} +.sb-announcement { + background: rgb(131, 131, 131); +} +.sb-announcement__inner { + background: black; + color: white; +} +.sb-header { + background: lightskyblue; +} +.sb-header__inner { + background: royalblue; + color: white; +} +.sb-header-secondary { + background: lightcyan; +} +.sb-header-secondary__inner { + background: cornflowerblue; + color: white; +} +.sb-sidebar-primary { + background: lightgreen; +} +.sb-main { + background: blanchedalmond; +} +.sb-main__inner { + background: antiquewhite; +} +.sb-header-article { + background: lightsteelblue; +} +.sb-article-container { + background: snow; +} +.sb-article-main { + background: white; +} +.sb-footer-article { + background: lightpink; +} +.sb-sidebar-secondary { + background: lightgoldenrodyellow; +} +.sb-footer-content { + background: plum; +} +.sb-footer-content__inner { + background: palevioletred; +} +.sb-footer { + background: pink; +} +.sb-footer__inner { + background: salmon; +} +.sb-article { + background: white; +} diff --git a/_static/doctools.js b/_static/doctools.js new file mode 100644 index 0000000..d06a71d --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/_static/documentation_options.js b/_static/documentation_options.js new file mode 100644 index 0000000..0888683 --- /dev/null +++ b/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: 'latest', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/_static/file.png b/_static/file.png new file mode 100644 index 0000000..a858a41 Binary files /dev/null and b/_static/file.png differ diff --git a/_static/graphviz.css b/_static/graphviz.css new file mode 100644 index 0000000..8d81c02 --- /dev/null +++ b/_static/graphviz.css @@ -0,0 +1,19 @@ +/* + * graphviz.css + * ~~~~~~~~~~~~ + * + * Sphinx stylesheet -- graphviz extension. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +img.graphviz { + border: 0; + max-width: 100%; +} + +object.graphviz { + max-width: 100%; +} diff --git a/_static/language_data.js b/_static/language_data.js new file mode 100644 index 0000000..250f566 --- /dev/null +++ b/_static/language_data.js @@ -0,0 +1,199 @@ +/* + * language_data.js + * ~~~~~~~~~~~~~~~~ + * + * This script contains the language-specific data used by searchtools.js, + * namely the list of stopwords, stemmer, scorer and splitter. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; + + +/* Non-minified version is copied as a separate JS file, is available */ + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/_static/logo/osvb.ico b/_static/logo/osvb.ico new file mode 100644 index 0000000..be652c4 Binary files /dev/null and b/_static/logo/osvb.ico differ diff --git a/_static/logo/osvb.png b/_static/logo/osvb.png new file mode 100644 index 0000000..d09b7fb Binary files /dev/null and b/_static/logo/osvb.png differ diff --git a/_static/logo/osvb.svg b/_static/logo/osvb.svg new file mode 100644 index 0000000..c318a41 --- /dev/null +++ b/_static/logo/osvb.svg @@ -0,0 +1,188 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + OSVB + + + + + diff --git a/_static/logo/osvb_banner_white.png b/_static/logo/osvb_banner_white.png new file mode 100644 index 0000000..c6bfcea Binary files /dev/null and b/_static/logo/osvb_banner_white.png differ diff --git a/_static/logo/osvb_banner_white.svg b/_static/logo/osvb_banner_white.svg new file mode 100644 index 0000000..4197a53 --- /dev/null +++ b/_static/logo/osvb_banner_white.svg @@ -0,0 +1,345 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/_static/logo/osvb_banners.svg b/_static/logo/osvb_banners.svg new file mode 100644 index 0000000..845c501 --- /dev/null +++ b/_static/logo/osvb_banners.svg @@ -0,0 +1,1079 @@ + + + +image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + OSVB + + + + + + + + + + + + + + + + + + + + + + + + + OSVB + + + + + + + + + + + + + + + + + + + + + + + + + OSVB + +Open SourceVerification Bundle +Open Source Verification Bundle +OSVB + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + OSVB +OSVB + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +OSVB + + + + + + + + + + + + + + + + + + + + + + + + + OSVB +OSVB +OSVB +Open Source Verification Bundle + \ No newline at end of file diff --git a/_static/minus.png b/_static/minus.png new file mode 100644 index 0000000..d96755f Binary files /dev/null and b/_static/minus.png differ diff --git a/_static/osvb.ico b/_static/osvb.ico new file mode 100644 index 0000000..be652c4 Binary files /dev/null and b/_static/osvb.ico differ diff --git a/_static/osvb.png b/_static/osvb.png new file mode 100644 index 0000000..01e833a Binary files /dev/null and b/_static/osvb.png differ diff --git a/_static/osvb_banner_white.svg b/_static/osvb_banner_white.svg new file mode 100644 index 0000000..4197a53 --- /dev/null +++ b/_static/osvb_banner_white.svg @@ -0,0 +1,345 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/_static/osvde.png b/_static/osvde.png new file mode 100644 index 0000000..ceed4a7 Binary files /dev/null and b/_static/osvde.png differ diff --git a/_static/plus.png b/_static/plus.png new file mode 100644 index 0000000..7107cec Binary files /dev/null and b/_static/plus.png differ diff --git a/_static/pyCAPI.png b/_static/pyCAPI.png new file mode 100644 index 0000000..af263de Binary files /dev/null and b/_static/pyCAPI.png differ diff --git a/_static/pygments.css b/_static/pygments.css new file mode 100644 index 0000000..c2e07c7 --- /dev/null +++ b/_static/pygments.css @@ -0,0 +1,258 @@ +.highlight pre { line-height: 125%; } +.highlight td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +.highlight span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +.highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #8f5902; font-style: italic } /* Comment */ +.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ +.highlight .g { color: #000000 } /* Generic */ +.highlight .k { color: #204a87; font-weight: bold } /* Keyword */ +.highlight .l { color: #000000 } /* Literal */ +.highlight .n { color: #000000 } /* Name */ +.highlight .o { color: #ce5c00; font-weight: bold } /* Operator */ +.highlight .x { color: #000000 } /* Other */ +.highlight .p { color: #000000; font-weight: bold } /* Punctuation */ +.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #8f5902; font-style: italic } /* Comment.Preproc */ +.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #a40000 } /* Generic.Deleted */ +.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ +.highlight .ges { color: #000000; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +.highlight .gr { color: #ef2929 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #000000; font-style: italic } /* Generic.Output */ +.highlight .gp { color: #8f5902 } /* Generic.Prompt */ +.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ +.highlight .kc { color: #204a87; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #204a87; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #204a87; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #204a87; font-weight: bold } /* Keyword.Pseudo */ +.highlight .kr { color: #204a87; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #204a87; font-weight: bold } /* Keyword.Type */ +.highlight .ld { color: #000000 } /* Literal.Date */ +.highlight .m { color: #0000cf; font-weight: bold } /* Literal.Number */ +.highlight .s { color: #4e9a06 } /* Literal.String */ +.highlight .na { color: #c4a000 } /* Name.Attribute */ +.highlight .nb { color: #204a87 } /* Name.Builtin */ +.highlight .nc { color: #000000 } /* Name.Class */ +.highlight .no { color: #000000 } /* Name.Constant */ +.highlight .nd { color: #5c35cc; font-weight: bold } /* Name.Decorator */ +.highlight .ni { color: #ce5c00 } /* Name.Entity */ +.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #000000 } /* Name.Function */ +.highlight .nl { color: #f57900 } /* Name.Label */ +.highlight .nn { color: #000000 } /* Name.Namespace */ +.highlight .nx { color: #000000 } /* Name.Other */ +.highlight .py { color: #000000 } /* Name.Property */ +.highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #000000 } /* Name.Variable */ +.highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ +.highlight .w { color: #f8f8f8 } /* Text.Whitespace */ +.highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ +.highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ +.highlight .mh { color: #0000cf; font-weight: bold } /* Literal.Number.Hex */ +.highlight .mi { color: #0000cf; font-weight: bold } /* Literal.Number.Integer */ +.highlight .mo { color: #0000cf; font-weight: bold } /* Literal.Number.Oct */ +.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ +.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ +.highlight .sc { color: #4e9a06 } /* Literal.String.Char */ +.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ +.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ +.highlight .se { color: #4e9a06 } /* Literal.String.Escape */ +.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ +.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ +.highlight .sx { color: #4e9a06 } /* Literal.String.Other */ +.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ +.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ +.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ +.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #000000 } /* Name.Function.Magic */ +.highlight .vc { color: #000000 } /* Name.Variable.Class */ +.highlight .vg { color: #000000 } /* Name.Variable.Global */ +.highlight .vi { color: #000000 } /* Name.Variable.Instance */ +.highlight .vm { color: #000000 } /* Name.Variable.Magic */ +.highlight .il { color: #0000cf; font-weight: bold } /* Literal.Number.Integer.Long */ +@media not print { +body[data-theme="dark"] .highlight pre { line-height: 125%; } +body[data-theme="dark"] .highlight td.linenos .normal { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } +body[data-theme="dark"] .highlight span.linenos { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } +body[data-theme="dark"] .highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +body[data-theme="dark"] .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +body[data-theme="dark"] .highlight .hll { background-color: #404040 } +body[data-theme="dark"] .highlight { background: #202020; color: #d0d0d0 } +body[data-theme="dark"] .highlight .c { color: #ababab; font-style: italic } /* Comment */ +body[data-theme="dark"] .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ +body[data-theme="dark"] .highlight .esc { color: #d0d0d0 } /* Escape */ +body[data-theme="dark"] .highlight .g { color: #d0d0d0 } /* Generic */ +body[data-theme="dark"] .highlight .k { color: #6ebf26; font-weight: bold } /* Keyword */ +body[data-theme="dark"] .highlight .l { color: #d0d0d0 } /* Literal */ +body[data-theme="dark"] .highlight .n { color: #d0d0d0 } /* Name */ +body[data-theme="dark"] .highlight .o { color: #d0d0d0 } /* Operator */ +body[data-theme="dark"] .highlight .x { color: #d0d0d0 } /* Other */ +body[data-theme="dark"] .highlight .p { color: #d0d0d0 } /* Punctuation */ +body[data-theme="dark"] .highlight .ch { color: #ababab; font-style: italic } /* Comment.Hashbang */ +body[data-theme="dark"] .highlight .cm { color: #ababab; font-style: italic } /* Comment.Multiline */ +body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* Comment.Preproc */ +body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ +body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ +body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ +body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ +body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ +body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ +body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ +body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ +body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ +body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ +body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ +body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ +body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ +body[data-theme="dark"] .highlight .kp { color: #6ebf26 } /* Keyword.Pseudo */ +body[data-theme="dark"] .highlight .kr { color: #6ebf26; font-weight: bold } /* Keyword.Reserved */ +body[data-theme="dark"] .highlight .kt { color: #6ebf26; font-weight: bold } /* Keyword.Type */ +body[data-theme="dark"] .highlight .ld { color: #d0d0d0 } /* Literal.Date */ +body[data-theme="dark"] .highlight .m { color: #51b2fd } /* Literal.Number */ +body[data-theme="dark"] .highlight .s { color: #ed9d13 } /* Literal.String */ +body[data-theme="dark"] .highlight .na { color: #bbbbbb } /* Name.Attribute */ +body[data-theme="dark"] .highlight .nb { color: #2fbccd } /* Name.Builtin */ +body[data-theme="dark"] .highlight .nc { color: #71adff; text-decoration: underline } /* Name.Class */ +body[data-theme="dark"] .highlight .no { color: #40ffff } /* Name.Constant */ +body[data-theme="dark"] .highlight .nd { color: #ffa500 } /* Name.Decorator */ +body[data-theme="dark"] .highlight .ni { color: #d0d0d0 } /* Name.Entity */ +body[data-theme="dark"] .highlight .ne { color: #bbbbbb } /* Name.Exception */ +body[data-theme="dark"] .highlight .nf { color: #71adff } /* Name.Function */ +body[data-theme="dark"] .highlight .nl { color: #d0d0d0 } /* Name.Label */ +body[data-theme="dark"] .highlight .nn { color: #71adff; text-decoration: underline } /* Name.Namespace */ +body[data-theme="dark"] .highlight .nx { color: #d0d0d0 } /* Name.Other */ +body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ +body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ +body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ +body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ +body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ +body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ +body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ +body[data-theme="dark"] .highlight .mh { color: #51b2fd } /* Literal.Number.Hex */ +body[data-theme="dark"] .highlight .mi { color: #51b2fd } /* Literal.Number.Integer */ +body[data-theme="dark"] .highlight .mo { color: #51b2fd } /* Literal.Number.Oct */ +body[data-theme="dark"] .highlight .sa { color: #ed9d13 } /* Literal.String.Affix */ +body[data-theme="dark"] .highlight .sb { color: #ed9d13 } /* Literal.String.Backtick */ +body[data-theme="dark"] .highlight .sc { color: #ed9d13 } /* Literal.String.Char */ +body[data-theme="dark"] .highlight .dl { color: #ed9d13 } /* Literal.String.Delimiter */ +body[data-theme="dark"] .highlight .sd { color: #ed9d13 } /* Literal.String.Doc */ +body[data-theme="dark"] .highlight .s2 { color: #ed9d13 } /* Literal.String.Double */ +body[data-theme="dark"] .highlight .se { color: #ed9d13 } /* Literal.String.Escape */ +body[data-theme="dark"] .highlight .sh { color: #ed9d13 } /* Literal.String.Heredoc */ +body[data-theme="dark"] .highlight .si { color: #ed9d13 } /* Literal.String.Interpol */ +body[data-theme="dark"] .highlight .sx { color: #ffa500 } /* Literal.String.Other */ +body[data-theme="dark"] .highlight .sr { color: #ed9d13 } /* Literal.String.Regex */ +body[data-theme="dark"] .highlight .s1 { color: #ed9d13 } /* Literal.String.Single */ +body[data-theme="dark"] .highlight .ss { color: #ed9d13 } /* Literal.String.Symbol */ +body[data-theme="dark"] .highlight .bp { color: #2fbccd } /* Name.Builtin.Pseudo */ +body[data-theme="dark"] .highlight .fm { color: #71adff } /* Name.Function.Magic */ +body[data-theme="dark"] .highlight .vc { color: #40ffff } /* Name.Variable.Class */ +body[data-theme="dark"] .highlight .vg { color: #40ffff } /* Name.Variable.Global */ +body[data-theme="dark"] .highlight .vi { color: #40ffff } /* Name.Variable.Instance */ +body[data-theme="dark"] .highlight .vm { color: #40ffff } /* Name.Variable.Magic */ +body[data-theme="dark"] .highlight .il { color: #51b2fd } /* Literal.Number.Integer.Long */ +@media (prefers-color-scheme: dark) { +body:not([data-theme="light"]) .highlight pre { line-height: 125%; } +body:not([data-theme="light"]) .highlight td.linenos .normal { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } +body:not([data-theme="light"]) .highlight span.linenos { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } +body:not([data-theme="light"]) .highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +body:not([data-theme="light"]) .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +body:not([data-theme="light"]) .highlight .hll { background-color: #404040 } +body:not([data-theme="light"]) .highlight { background: #202020; color: #d0d0d0 } +body:not([data-theme="light"]) .highlight .c { color: #ababab; font-style: italic } /* Comment */ +body:not([data-theme="light"]) .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ +body:not([data-theme="light"]) .highlight .esc { color: #d0d0d0 } /* Escape */ +body:not([data-theme="light"]) .highlight .g { color: #d0d0d0 } /* Generic */ +body:not([data-theme="light"]) .highlight .k { color: #6ebf26; font-weight: bold } /* Keyword */ +body:not([data-theme="light"]) .highlight .l { color: #d0d0d0 } /* Literal */ +body:not([data-theme="light"]) .highlight .n { color: #d0d0d0 } /* Name */ +body:not([data-theme="light"]) .highlight .o { color: #d0d0d0 } /* Operator */ +body:not([data-theme="light"]) .highlight .x { color: #d0d0d0 } /* Other */ +body:not([data-theme="light"]) .highlight .p { color: #d0d0d0 } /* Punctuation */ +body:not([data-theme="light"]) .highlight .ch { color: #ababab; font-style: italic } /* Comment.Hashbang */ +body:not([data-theme="light"]) .highlight .cm { color: #ababab; font-style: italic } /* Comment.Multiline */ +body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bold } /* Comment.Preproc */ +body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ +body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ +body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ +body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ +body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ +body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ +body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ +body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ +body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ +body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ +body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ +body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ +body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ +body:not([data-theme="light"]) .highlight .kp { color: #6ebf26 } /* Keyword.Pseudo */ +body:not([data-theme="light"]) .highlight .kr { color: #6ebf26; font-weight: bold } /* Keyword.Reserved */ +body:not([data-theme="light"]) .highlight .kt { color: #6ebf26; font-weight: bold } /* Keyword.Type */ +body:not([data-theme="light"]) .highlight .ld { color: #d0d0d0 } /* Literal.Date */ +body:not([data-theme="light"]) .highlight .m { color: #51b2fd } /* Literal.Number */ +body:not([data-theme="light"]) .highlight .s { color: #ed9d13 } /* Literal.String */ +body:not([data-theme="light"]) .highlight .na { color: #bbbbbb } /* Name.Attribute */ +body:not([data-theme="light"]) .highlight .nb { color: #2fbccd } /* Name.Builtin */ +body:not([data-theme="light"]) .highlight .nc { color: #71adff; text-decoration: underline } /* Name.Class */ +body:not([data-theme="light"]) .highlight .no { color: #40ffff } /* Name.Constant */ +body:not([data-theme="light"]) .highlight .nd { color: #ffa500 } /* Name.Decorator */ +body:not([data-theme="light"]) .highlight .ni { color: #d0d0d0 } /* Name.Entity */ +body:not([data-theme="light"]) .highlight .ne { color: #bbbbbb } /* Name.Exception */ +body:not([data-theme="light"]) .highlight .nf { color: #71adff } /* Name.Function */ +body:not([data-theme="light"]) .highlight .nl { color: #d0d0d0 } /* Name.Label */ +body:not([data-theme="light"]) .highlight .nn { color: #71adff; text-decoration: underline } /* Name.Namespace */ +body:not([data-theme="light"]) .highlight .nx { color: #d0d0d0 } /* Name.Other */ +body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Property */ +body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ +body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ +body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ +body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ +body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ +body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ +body:not([data-theme="light"]) .highlight .mh { color: #51b2fd } /* Literal.Number.Hex */ +body:not([data-theme="light"]) .highlight .mi { color: #51b2fd } /* Literal.Number.Integer */ +body:not([data-theme="light"]) .highlight .mo { color: #51b2fd } /* Literal.Number.Oct */ +body:not([data-theme="light"]) .highlight .sa { color: #ed9d13 } /* Literal.String.Affix */ +body:not([data-theme="light"]) .highlight .sb { color: #ed9d13 } /* Literal.String.Backtick */ +body:not([data-theme="light"]) .highlight .sc { color: #ed9d13 } /* Literal.String.Char */ +body:not([data-theme="light"]) .highlight .dl { color: #ed9d13 } /* Literal.String.Delimiter */ +body:not([data-theme="light"]) .highlight .sd { color: #ed9d13 } /* Literal.String.Doc */ +body:not([data-theme="light"]) .highlight .s2 { color: #ed9d13 } /* Literal.String.Double */ +body:not([data-theme="light"]) .highlight .se { color: #ed9d13 } /* Literal.String.Escape */ +body:not([data-theme="light"]) .highlight .sh { color: #ed9d13 } /* Literal.String.Heredoc */ +body:not([data-theme="light"]) .highlight .si { color: #ed9d13 } /* Literal.String.Interpol */ +body:not([data-theme="light"]) .highlight .sx { color: #ffa500 } /* Literal.String.Other */ +body:not([data-theme="light"]) .highlight .sr { color: #ed9d13 } /* Literal.String.Regex */ +body:not([data-theme="light"]) .highlight .s1 { color: #ed9d13 } /* Literal.String.Single */ +body:not([data-theme="light"]) .highlight .ss { color: #ed9d13 } /* Literal.String.Symbol */ +body:not([data-theme="light"]) .highlight .bp { color: #2fbccd } /* Name.Builtin.Pseudo */ +body:not([data-theme="light"]) .highlight .fm { color: #71adff } /* Name.Function.Magic */ +body:not([data-theme="light"]) .highlight .vc { color: #40ffff } /* Name.Variable.Class */ +body:not([data-theme="light"]) .highlight .vg { color: #40ffff } /* Name.Variable.Global */ +body:not([data-theme="light"]) .highlight .vi { color: #40ffff } /* Name.Variable.Instance */ +body:not([data-theme="light"]) .highlight .vm { color: #40ffff } /* Name.Variable.Magic */ +body:not([data-theme="light"]) .highlight .il { color: #51b2fd } /* Literal.Number.Integer.Long */ +} +} \ No newline at end of file diff --git a/_static/runner_cfg.png b/_static/runner_cfg.png new file mode 100644 index 0000000..3e60f8a Binary files /dev/null and b/_static/runner_cfg.png differ diff --git a/_static/scripts/furo-extensions.js b/_static/scripts/furo-extensions.js new file mode 100644 index 0000000..e69de29 diff --git a/_static/scripts/furo.js b/_static/scripts/furo.js new file mode 100644 index 0000000..32e7c05 --- /dev/null +++ b/_static/scripts/furo.js @@ -0,0 +1,3 @@ +/*! For license information please see furo.js.LICENSE.txt */ +(()=>{var t={212:function(t,e,n){var o,r;r=void 0!==n.g?n.g:"undefined"!=typeof window?window:this,o=function(){return function(t){"use strict";var e={navClass:"active",contentClass:"active",nested:!1,nestedClass:"active",offset:0,reflow:!1,events:!0},n=function(t,e,n){if(n.settings.events){var o=new CustomEvent(t,{bubbles:!0,cancelable:!0,detail:n});e.dispatchEvent(o)}},o=function(t){var e=0;if(t.offsetParent)for(;t;)e+=t.offsetTop,t=t.offsetParent;return e>=0?e:0},r=function(t){t&&t.sort((function(t,e){return o(t.content)=Math.max(document.body.scrollHeight,document.documentElement.scrollHeight,document.body.offsetHeight,document.documentElement.offsetHeight,document.body.clientHeight,document.documentElement.clientHeight)},l=function(t,e){var n=t[t.length-1];if(function(t,e){return!(!s()||!c(t.content,e,!0))}(n,e))return n;for(var o=t.length-1;o>=0;o--)if(c(t[o].content,e))return t[o]},a=function(t,e){if(e.nested&&t.parentNode){var n=t.parentNode.closest("li");n&&(n.classList.remove(e.nestedClass),a(n,e))}},i=function(t,e){if(t){var o=t.nav.closest("li");o&&(o.classList.remove(e.navClass),t.content.classList.remove(e.contentClass),a(o,e),n("gumshoeDeactivate",o,{link:t.nav,content:t.content,settings:e}))}},u=function(t,e){if(e.nested){var n=t.parentNode.closest("li");n&&(n.classList.add(e.nestedClass),u(n,e))}};return function(o,c){var s,a,d,f,m,v={setup:function(){s=document.querySelectorAll(o),a=[],Array.prototype.forEach.call(s,(function(t){var e=document.getElementById(decodeURIComponent(t.hash.substr(1)));e&&a.push({nav:t,content:e})})),r(a)},detect:function(){var t=l(a,m);t?d&&t.content===d.content||(i(d,m),function(t,e){if(t){var o=t.nav.closest("li");o&&(o.classList.add(e.navClass),t.content.classList.add(e.contentClass),u(o,e),n("gumshoeActivate",o,{link:t.nav,content:t.content,settings:e}))}}(t,m),d=t):d&&(i(d,m),d=null)}},h=function(e){f&&t.cancelAnimationFrame(f),f=t.requestAnimationFrame(v.detect)},g=function(e){f&&t.cancelAnimationFrame(f),f=t.requestAnimationFrame((function(){r(a),v.detect()}))};return v.destroy=function(){d&&i(d,m),t.removeEventListener("scroll",h,!1),m.reflow&&t.removeEventListener("resize",g,!1),a=null,s=null,d=null,f=null,m=null},m=function(){var t={};return Array.prototype.forEach.call(arguments,(function(e){for(var n in e){if(!e.hasOwnProperty(n))return;t[n]=e[n]}})),t}(e,c||{}),v.setup(),v.detect(),t.addEventListener("scroll",h,!1),m.reflow&&t.addEventListener("resize",g,!1),v}}(r)}.apply(e,[]),void 0===o||(t.exports=o)}},e={};function n(o){var r=e[o];if(void 0!==r)return r.exports;var c=e[o]={exports:{}};return t[o].call(c.exports,c,c.exports,n),c.exports}n.n=t=>{var e=t&&t.__esModule?()=>t.default:()=>t;return n.d(e,{a:e}),e},n.d=(t,e)=>{for(var o in e)n.o(e,o)&&!n.o(t,o)&&Object.defineProperty(t,o,{enumerable:!0,get:e[o]})},n.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(t){if("object"==typeof window)return window}}(),n.o=(t,e)=>Object.prototype.hasOwnProperty.call(t,e),(()=>{"use strict";var t=n(212),e=n.n(t),o=null,r=null,c=window.pageYOffset||document.documentElement.scrollTop;const s=64;function l(){const t=localStorage.getItem("theme")||"auto";var e;"light"!==(e=window.matchMedia("(prefers-color-scheme: dark)").matches?"auto"===t?"light":"light"==t?"dark":"auto":"auto"===t?"dark":"dark"==t?"light":"auto")&&"dark"!==e&&"auto"!==e&&(console.error(`Got invalid theme mode: ${e}. Resetting to auto.`),e="auto"),document.body.dataset.theme=e,localStorage.setItem("theme",e),console.log(`Changed to ${e} mode.`)}function a(){!function(){const t=document.getElementsByClassName("theme-toggle");Array.from(t).forEach((t=>{t.addEventListener("click",l)}))}(),function(){let t=0,e=!1;window.addEventListener("scroll",(function(n){t=window.scrollY,e||(window.requestAnimationFrame((function(){var n;n=t,0==Math.floor(r.getBoundingClientRect().top)?r.classList.add("scrolled"):r.classList.remove("scrolled"),function(t){tc&&document.documentElement.classList.remove("show-back-to-top"),c=t}(n),function(t){null!==o&&(0==t?o.scrollTo(0,0):Math.ceil(t)>=Math.floor(document.documentElement.scrollHeight-window.innerHeight)?o.scrollTo(0,o.scrollHeight):document.querySelector(".scroll-current"))}(n),e=!1})),e=!0)})),window.scroll()}(),null!==o&&new(e())(".toc-tree a",{reflow:!0,recursive:!0,navClass:"scroll-current",offset:()=>{let t=parseFloat(getComputedStyle(document.documentElement).fontSize);return r.getBoundingClientRect().height+.5*t+1}})}document.addEventListener("DOMContentLoaded",(function(){document.body.parentNode.classList.remove("no-js"),r=document.querySelector("header"),o=document.querySelector(".toc-scroll"),a()}))})()})(); +//# sourceMappingURL=furo.js.map \ No newline at end of file diff --git a/_static/scripts/furo.js.LICENSE.txt b/_static/scripts/furo.js.LICENSE.txt new file mode 100644 index 0000000..1632189 --- /dev/null +++ b/_static/scripts/furo.js.LICENSE.txt @@ -0,0 +1,7 @@ +/*! + * gumshoejs v5.1.2 (patched by @pradyunsg) + * A simple, framework-agnostic scrollspy script. + * (c) 2019 Chris Ferdinandi + * MIT License + * http://github.com/cferdinandi/gumshoe + */ diff --git a/_static/scripts/furo.js.map b/_static/scripts/furo.js.map new file mode 100644 index 0000000..7b7ddb1 --- /dev/null +++ b/_static/scripts/furo.js.map @@ -0,0 +1 @@ +{"version":3,"file":"scripts/furo.js","mappings":";iCAAA,MAQWA,SAWS,IAAX,EAAAC,EACH,EAAAA,EACkB,oBAAXC,OACPA,OACAC,KAbS,EAAF,WACP,OAaJ,SAAUD,GACR,aAMA,IAAIE,EAAW,CAEbC,SAAU,SACVC,aAAc,SAGdC,QAAQ,EACRC,YAAa,SAGbC,OAAQ,EACRC,QAAQ,EAGRC,QAAQ,GA6BNC,EAAY,SAAUC,EAAMC,EAAMC,GAEpC,GAAKA,EAAOC,SAASL,OAArB,CAGA,IAAIM,EAAQ,IAAIC,YAAYL,EAAM,CAChCM,SAAS,EACTC,YAAY,EACZL,OAAQA,IAIVD,EAAKO,cAAcJ,EAVgB,CAWrC,EAOIK,EAAe,SAAUR,GAC3B,IAAIS,EAAW,EACf,GAAIT,EAAKU,aACP,KAAOV,GACLS,GAAYT,EAAKW,UACjBX,EAAOA,EAAKU,aAGhB,OAAOD,GAAY,EAAIA,EAAW,CACpC,EAMIG,EAAe,SAAUC,GACvBA,GACFA,EAASC,MAAK,SAAUC,EAAOC,GAG7B,OAFcR,EAAaO,EAAME,SACnBT,EAAaQ,EAAMC,UACF,EACxB,CACT,GAEJ,EAwCIC,EAAW,SAAUlB,EAAME,EAAUiB,GACvC,IAAIC,EAASpB,EAAKqB,wBACd1B,EAnCU,SAAUO,GAExB,MAA+B,mBAApBA,EAASP,OACX2B,WAAWpB,EAASP,UAItB2B,WAAWpB,EAASP,OAC7B,CA2Be4B,CAAUrB,GACvB,OAAIiB,EAEAK,SAASJ,EAAOD,OAAQ,KACvB/B,EAAOqC,aAAeC,SAASC,gBAAgBC,cAG7CJ,SAASJ,EAAOS,IAAK,KAAOlC,CACrC,EAMImC,EAAa,WACf,OACEC,KAAKC,KAAK5C,EAAOqC,YAAcrC,EAAO6C,cAnCjCF,KAAKG,IACVR,SAASS,KAAKC,aACdV,SAASC,gBAAgBS,aACzBV,SAASS,KAAKE,aACdX,SAASC,gBAAgBU,aACzBX,SAASS,KAAKP,aACdF,SAASC,gBAAgBC,aAkC7B,EAmBIU,EAAY,SAAUzB,EAAUX,GAClC,IAAIqC,EAAO1B,EAASA,EAAS2B,OAAS,GACtC,GAbgB,SAAUC,EAAMvC,GAChC,SAAI4B,MAAgBZ,EAASuB,EAAKxB,QAASf,GAAU,GAEvD,CAUMwC,CAAYH,EAAMrC,GAAW,OAAOqC,EACxC,IAAK,IAAII,EAAI9B,EAAS2B,OAAS,EAAGG,GAAK,EAAGA,IACxC,GAAIzB,EAASL,EAAS8B,GAAG1B,QAASf,GAAW,OAAOW,EAAS8B,EAEjE,EAOIC,EAAmB,SAAUC,EAAK3C,GAEpC,GAAKA,EAAST,QAAWoD,EAAIC,WAA7B,CAGA,IAAIC,EAAKF,EAAIC,WAAWE,QAAQ,MAC3BD,IAGLA,EAAGE,UAAUC,OAAOhD,EAASR,aAG7BkD,EAAiBG,EAAI7C,GAV0B,CAWjD,EAOIiD,EAAa,SAAUC,EAAOlD,GAEhC,GAAKkD,EAAL,CAGA,IAAIL,EAAKK,EAAMP,IAAIG,QAAQ,MACtBD,IAGLA,EAAGE,UAAUC,OAAOhD,EAASX,UAC7B6D,EAAMnC,QAAQgC,UAAUC,OAAOhD,EAASV,cAGxCoD,EAAiBG,EAAI7C,GAGrBJ,EAAU,oBAAqBiD,EAAI,CACjCM,KAAMD,EAAMP,IACZ5B,QAASmC,EAAMnC,QACff,SAAUA,IAjBM,CAmBpB,EAOIoD,EAAiB,SAAUT,EAAK3C,GAElC,GAAKA,EAAST,OAAd,CAGA,IAAIsD,EAAKF,EAAIC,WAAWE,QAAQ,MAC3BD,IAGLA,EAAGE,UAAUM,IAAIrD,EAASR,aAG1B4D,EAAeP,EAAI7C,GAVS,CAW9B,EA6LA,OA1JkB,SAAUsD,EAAUC,GAKpC,IACIC,EAAU7C,EAAU8C,EAASC,EAAS1D,EADtC2D,EAAa,CAUjBA,MAAmB,WAEjBH,EAAWhC,SAASoC,iBAAiBN,GAGrC3C,EAAW,GAGXkD,MAAMC,UAAUC,QAAQC,KAAKR,GAAU,SAAUjB,GAE/C,IAAIxB,EAAUS,SAASyC,eACrBC,mBAAmB3B,EAAK4B,KAAKC,OAAO,KAEjCrD,GAGLJ,EAAS0D,KAAK,CACZ1B,IAAKJ,EACLxB,QAASA,GAEb,IAGAL,EAAaC,EACf,EAKAgD,OAAoB,WAElB,IAAIW,EAASlC,EAAUzB,EAAUX,GAG5BsE,EASDb,GAAWa,EAAOvD,UAAY0C,EAAQ1C,UAG1CkC,EAAWQ,EAASzD,GAzFT,SAAUkD,EAAOlD,GAE9B,GAAKkD,EAAL,CAGA,IAAIL,EAAKK,EAAMP,IAAIG,QAAQ,MACtBD,IAGLA,EAAGE,UAAUM,IAAIrD,EAASX,UAC1B6D,EAAMnC,QAAQgC,UAAUM,IAAIrD,EAASV,cAGrC8D,EAAeP,EAAI7C,GAGnBJ,EAAU,kBAAmBiD,EAAI,CAC/BM,KAAMD,EAAMP,IACZ5B,QAASmC,EAAMnC,QACff,SAAUA,IAjBM,CAmBpB,CAqEIuE,CAASD,EAAQtE,GAGjByD,EAAUa,GAfJb,IACFR,EAAWQ,EAASzD,GACpByD,EAAU,KAchB,GAMIe,EAAgB,SAAUvE,GAExByD,GACFxE,EAAOuF,qBAAqBf,GAI9BA,EAAUxE,EAAOwF,sBAAsBf,EAAWgB,OACpD,EAMIC,EAAgB,SAAU3E,GAExByD,GACFxE,EAAOuF,qBAAqBf,GAI9BA,EAAUxE,EAAOwF,uBAAsB,WACrChE,EAAaC,GACbgD,EAAWgB,QACb,GACF,EAkDA,OA7CAhB,EAAWkB,QAAU,WAEfpB,GACFR,EAAWQ,EAASzD,GAItBd,EAAO4F,oBAAoB,SAAUN,GAAe,GAChDxE,EAASN,QACXR,EAAO4F,oBAAoB,SAAUF,GAAe,GAItDjE,EAAW,KACX6C,EAAW,KACXC,EAAU,KACVC,EAAU,KACV1D,EAAW,IACb,EAOEA,EA3XS,WACX,IAAI+E,EAAS,CAAC,EAOd,OANAlB,MAAMC,UAAUC,QAAQC,KAAKgB,WAAW,SAAUC,GAChD,IAAK,IAAIC,KAAOD,EAAK,CACnB,IAAKA,EAAIE,eAAeD,GAAM,OAC9BH,EAAOG,GAAOD,EAAIC,EACpB,CACF,IACOH,CACT,CAkXeK,CAAOhG,EAAUmE,GAAW,CAAC,GAGxCI,EAAW0B,QAGX1B,EAAWgB,SAGXzF,EAAOoG,iBAAiB,SAAUd,GAAe,GAC7CxE,EAASN,QACXR,EAAOoG,iBAAiB,SAAUV,GAAe,GAS9CjB,CACT,CAOF,CArcW4B,CAAQvG,EAChB,UAFM,SAEN,uBCXDwG,EAA2B,CAAC,EAGhC,SAASC,EAAoBC,GAE5B,IAAIC,EAAeH,EAAyBE,GAC5C,QAAqBE,IAAjBD,EACH,OAAOA,EAAaE,QAGrB,IAAIC,EAASN,EAAyBE,GAAY,CAGjDG,QAAS,CAAC,GAOX,OAHAE,EAAoBL,GAAU1B,KAAK8B,EAAOD,QAASC,EAAQA,EAAOD,QAASJ,GAGpEK,EAAOD,OACf,CCrBAJ,EAAoBO,EAAKF,IACxB,IAAIG,EAASH,GAAUA,EAAOI,WAC7B,IAAOJ,EAAiB,QACxB,IAAM,EAEP,OADAL,EAAoBU,EAAEF,EAAQ,CAAEG,EAAGH,IAC5BA,CAAM,ECLdR,EAAoBU,EAAI,CAACN,EAASQ,KACjC,IAAI,IAAInB,KAAOmB,EACXZ,EAAoBa,EAAED,EAAYnB,KAASO,EAAoBa,EAAET,EAASX,IAC5EqB,OAAOC,eAAeX,EAASX,EAAK,CAAEuB,YAAY,EAAMC,IAAKL,EAAWnB,IAE1E,ECNDO,EAAoBxG,EAAI,WACvB,GAA0B,iBAAf0H,WAAyB,OAAOA,WAC3C,IACC,OAAOxH,MAAQ,IAAIyH,SAAS,cAAb,EAChB,CAAE,MAAOC,GACR,GAAsB,iBAAX3H,OAAqB,OAAOA,MACxC,CACA,CAPuB,GCAxBuG,EAAoBa,EAAI,CAACrB,EAAK6B,IAAUP,OAAOzC,UAAUqB,eAAenB,KAAKiB,EAAK6B,4CCK9EC,EAAY,KACZC,EAAS,KACTC,EAAgB/H,OAAO6C,aAAeP,SAASC,gBAAgByF,UACnE,MAAMC,EAAmB,GA2EzB,SAASC,IACP,MAAMC,EAAeC,aAAaC,QAAQ,UAAY,OAZxD,IAAkBC,EACH,WADGA,EAaItI,OAAOuI,WAAW,gCAAgCC,QAI/C,SAAjBL,EACO,QACgB,SAAhBA,EACA,OAEA,OAIU,SAAjBA,EACO,OACgB,QAAhBA,EACA,QAEA,SA9BoB,SAATG,GAA4B,SAATA,IACzCG,QAAQC,MAAM,2BAA2BJ,yBACzCA,EAAO,QAGThG,SAASS,KAAK4F,QAAQC,MAAQN,EAC9BF,aAAaS,QAAQ,QAASP,GAC9BG,QAAQK,IAAI,cAAcR,UA0B5B,CAkDA,SAASnC,KART,WAEE,MAAM4C,EAAUzG,SAAS0G,uBAAuB,gBAChDrE,MAAMsE,KAAKF,GAASlE,SAASqE,IAC3BA,EAAI9C,iBAAiB,QAAS8B,EAAe,GAEjD,CAGEiB,GA9CF,WAEE,IAAIC,EAA6B,EAC7BC,GAAU,EAEdrJ,OAAOoG,iBAAiB,UAAU,SAAUuB,GAC1CyB,EAA6BpJ,OAAOsJ,QAE/BD,IACHrJ,OAAOwF,uBAAsB,WAzDnC,IAAuB+D,IA0DDH,EA9GkC,GAAlDzG,KAAK6G,MAAM1B,EAAO7F,wBAAwBQ,KAC5CqF,EAAOjE,UAAUM,IAAI,YAErB2D,EAAOjE,UAAUC,OAAO,YAI5B,SAAmCyF,GAC7BA,EAAYtB,EACd3F,SAASC,gBAAgBsB,UAAUC,OAAO,oBAEtCyF,EAAYxB,EACdzF,SAASC,gBAAgBsB,UAAUM,IAAI,oBAC9BoF,EAAYxB,GACrBzF,SAASC,gBAAgBsB,UAAUC,OAAO,oBAG9CiE,EAAgBwB,CAClB,CAoCEE,CAA0BF,GAlC5B,SAA6BA,GACT,OAAd1B,IAKa,GAAb0B,EACF1B,EAAU6B,SAAS,EAAG,GAGtB/G,KAAKC,KAAK2G,IACV5G,KAAK6G,MAAMlH,SAASC,gBAAgBS,aAAehD,OAAOqC,aAE1DwF,EAAU6B,SAAS,EAAG7B,EAAU7E,cAGhBV,SAASqH,cAAc,mBAc3C,CAKEC,CAAoBL,GAwDdF,GAAU,CACZ,IAEAA,GAAU,EAEd,IACArJ,OAAO6J,QACT,CA6BEC,GA1BkB,OAAdjC,GAKJ,IAAI,IAAJ,CAAY,cAAe,CACzBrH,QAAQ,EACRuJ,WAAW,EACX5J,SAAU,iBACVI,OAAQ,KACN,IAAIyJ,EAAM9H,WAAW+H,iBAAiB3H,SAASC,iBAAiB2H,UAChE,OAAOpC,EAAO7F,wBAAwBkI,OAAS,GAAMH,EAAM,CAAC,GAiBlE,CAcA1H,SAAS8D,iBAAiB,oBAT1B,WACE9D,SAASS,KAAKW,WAAWG,UAAUC,OAAO,SAE1CgE,EAASxF,SAASqH,cAAc,UAChC9B,EAAYvF,SAASqH,cAAc,eAEnCxD,GACF","sources":["webpack:///./src/furo/assets/scripts/gumshoe-patched.js","webpack:///webpack/bootstrap","webpack:///webpack/runtime/compat get default export","webpack:///webpack/runtime/define property getters","webpack:///webpack/runtime/global","webpack:///webpack/runtime/hasOwnProperty shorthand","webpack:///./src/furo/assets/scripts/furo.js"],"sourcesContent":["/*!\n * gumshoejs v5.1.2 (patched by @pradyunsg)\n * A simple, framework-agnostic scrollspy script.\n * (c) 2019 Chris Ferdinandi\n * MIT License\n * http://github.com/cferdinandi/gumshoe\n */\n\n(function (root, factory) {\n if (typeof define === \"function\" && define.amd) {\n define([], function () {\n return factory(root);\n });\n } else if (typeof exports === \"object\") {\n module.exports = factory(root);\n } else {\n root.Gumshoe = factory(root);\n }\n})(\n typeof global !== \"undefined\"\n ? global\n : typeof window !== \"undefined\"\n ? window\n : this,\n function (window) {\n \"use strict\";\n\n //\n // Defaults\n //\n\n var defaults = {\n // Active classes\n navClass: \"active\",\n contentClass: \"active\",\n\n // Nested navigation\n nested: false,\n nestedClass: \"active\",\n\n // Offset & reflow\n offset: 0,\n reflow: false,\n\n // Event support\n events: true,\n };\n\n //\n // Methods\n //\n\n /**\n * Merge two or more objects together.\n * @param {Object} objects The objects to merge together\n * @returns {Object} Merged values of defaults and options\n */\n var extend = function () {\n var merged = {};\n Array.prototype.forEach.call(arguments, function (obj) {\n for (var key in obj) {\n if (!obj.hasOwnProperty(key)) return;\n merged[key] = obj[key];\n }\n });\n return merged;\n };\n\n /**\n * Emit a custom event\n * @param {String} type The event type\n * @param {Node} elem The element to attach the event to\n * @param {Object} detail Any details to pass along with the event\n */\n var emitEvent = function (type, elem, detail) {\n // Make sure events are enabled\n if (!detail.settings.events) return;\n\n // Create a new event\n var event = new CustomEvent(type, {\n bubbles: true,\n cancelable: true,\n detail: detail,\n });\n\n // Dispatch the event\n elem.dispatchEvent(event);\n };\n\n /**\n * Get an element's distance from the top of the Document.\n * @param {Node} elem The element\n * @return {Number} Distance from the top in pixels\n */\n var getOffsetTop = function (elem) {\n var location = 0;\n if (elem.offsetParent) {\n while (elem) {\n location += elem.offsetTop;\n elem = elem.offsetParent;\n }\n }\n return location >= 0 ? location : 0;\n };\n\n /**\n * Sort content from first to last in the DOM\n * @param {Array} contents The content areas\n */\n var sortContents = function (contents) {\n if (contents) {\n contents.sort(function (item1, item2) {\n var offset1 = getOffsetTop(item1.content);\n var offset2 = getOffsetTop(item2.content);\n if (offset1 < offset2) return -1;\n return 1;\n });\n }\n };\n\n /**\n * Get the offset to use for calculating position\n * @param {Object} settings The settings for this instantiation\n * @return {Float} The number of pixels to offset the calculations\n */\n var getOffset = function (settings) {\n // if the offset is a function run it\n if (typeof settings.offset === \"function\") {\n return parseFloat(settings.offset());\n }\n\n // Otherwise, return it as-is\n return parseFloat(settings.offset);\n };\n\n /**\n * Get the document element's height\n * @private\n * @returns {Number}\n */\n var getDocumentHeight = function () {\n return Math.max(\n document.body.scrollHeight,\n document.documentElement.scrollHeight,\n document.body.offsetHeight,\n document.documentElement.offsetHeight,\n document.body.clientHeight,\n document.documentElement.clientHeight,\n );\n };\n\n /**\n * Determine if an element is in view\n * @param {Node} elem The element\n * @param {Object} settings The settings for this instantiation\n * @param {Boolean} bottom If true, check if element is above bottom of viewport instead\n * @return {Boolean} Returns true if element is in the viewport\n */\n var isInView = function (elem, settings, bottom) {\n var bounds = elem.getBoundingClientRect();\n var offset = getOffset(settings);\n if (bottom) {\n return (\n parseInt(bounds.bottom, 10) <\n (window.innerHeight || document.documentElement.clientHeight)\n );\n }\n return parseInt(bounds.top, 10) <= offset;\n };\n\n /**\n * Check if at the bottom of the viewport\n * @return {Boolean} If true, page is at the bottom of the viewport\n */\n var isAtBottom = function () {\n if (\n Math.ceil(window.innerHeight + window.pageYOffset) >=\n getDocumentHeight()\n )\n return true;\n return false;\n };\n\n /**\n * Check if the last item should be used (even if not at the top of the page)\n * @param {Object} item The last item\n * @param {Object} settings The settings for this instantiation\n * @return {Boolean} If true, use the last item\n */\n var useLastItem = function (item, settings) {\n if (isAtBottom() && isInView(item.content, settings, true)) return true;\n return false;\n };\n\n /**\n * Get the active content\n * @param {Array} contents The content areas\n * @param {Object} settings The settings for this instantiation\n * @return {Object} The content area and matching navigation link\n */\n var getActive = function (contents, settings) {\n var last = contents[contents.length - 1];\n if (useLastItem(last, settings)) return last;\n for (var i = contents.length - 1; i >= 0; i--) {\n if (isInView(contents[i].content, settings)) return contents[i];\n }\n };\n\n /**\n * Deactivate parent navs in a nested navigation\n * @param {Node} nav The starting navigation element\n * @param {Object} settings The settings for this instantiation\n */\n var deactivateNested = function (nav, settings) {\n // If nesting isn't activated, bail\n if (!settings.nested || !nav.parentNode) return;\n\n // Get the parent navigation\n var li = nav.parentNode.closest(\"li\");\n if (!li) return;\n\n // Remove the active class\n li.classList.remove(settings.nestedClass);\n\n // Apply recursively to any parent navigation elements\n deactivateNested(li, settings);\n };\n\n /**\n * Deactivate a nav and content area\n * @param {Object} items The nav item and content to deactivate\n * @param {Object} settings The settings for this instantiation\n */\n var deactivate = function (items, settings) {\n // Make sure there are items to deactivate\n if (!items) return;\n\n // Get the parent list item\n var li = items.nav.closest(\"li\");\n if (!li) return;\n\n // Remove the active class from the nav and content\n li.classList.remove(settings.navClass);\n items.content.classList.remove(settings.contentClass);\n\n // Deactivate any parent navs in a nested navigation\n deactivateNested(li, settings);\n\n // Emit a custom event\n emitEvent(\"gumshoeDeactivate\", li, {\n link: items.nav,\n content: items.content,\n settings: settings,\n });\n };\n\n /**\n * Activate parent navs in a nested navigation\n * @param {Node} nav The starting navigation element\n * @param {Object} settings The settings for this instantiation\n */\n var activateNested = function (nav, settings) {\n // If nesting isn't activated, bail\n if (!settings.nested) return;\n\n // Get the parent navigation\n var li = nav.parentNode.closest(\"li\");\n if (!li) return;\n\n // Add the active class\n li.classList.add(settings.nestedClass);\n\n // Apply recursively to any parent navigation elements\n activateNested(li, settings);\n };\n\n /**\n * Activate a nav and content area\n * @param {Object} items The nav item and content to activate\n * @param {Object} settings The settings for this instantiation\n */\n var activate = function (items, settings) {\n // Make sure there are items to activate\n if (!items) return;\n\n // Get the parent list item\n var li = items.nav.closest(\"li\");\n if (!li) return;\n\n // Add the active class to the nav and content\n li.classList.add(settings.navClass);\n items.content.classList.add(settings.contentClass);\n\n // Activate any parent navs in a nested navigation\n activateNested(li, settings);\n\n // Emit a custom event\n emitEvent(\"gumshoeActivate\", li, {\n link: items.nav,\n content: items.content,\n settings: settings,\n });\n };\n\n /**\n * Create the Constructor object\n * @param {String} selector The selector to use for navigation items\n * @param {Object} options User options and settings\n */\n var Constructor = function (selector, options) {\n //\n // Variables\n //\n\n var publicAPIs = {};\n var navItems, contents, current, timeout, settings;\n\n //\n // Methods\n //\n\n /**\n * Set variables from DOM elements\n */\n publicAPIs.setup = function () {\n // Get all nav items\n navItems = document.querySelectorAll(selector);\n\n // Create contents array\n contents = [];\n\n // Loop through each item, get it's matching content, and push to the array\n Array.prototype.forEach.call(navItems, function (item) {\n // Get the content for the nav item\n var content = document.getElementById(\n decodeURIComponent(item.hash.substr(1)),\n );\n if (!content) return;\n\n // Push to the contents array\n contents.push({\n nav: item,\n content: content,\n });\n });\n\n // Sort contents by the order they appear in the DOM\n sortContents(contents);\n };\n\n /**\n * Detect which content is currently active\n */\n publicAPIs.detect = function () {\n // Get the active content\n var active = getActive(contents, settings);\n\n // if there's no active content, deactivate and bail\n if (!active) {\n if (current) {\n deactivate(current, settings);\n current = null;\n }\n return;\n }\n\n // If the active content is the one currently active, do nothing\n if (current && active.content === current.content) return;\n\n // Deactivate the current content and activate the new content\n deactivate(current, settings);\n activate(active, settings);\n\n // Update the currently active content\n current = active;\n };\n\n /**\n * Detect the active content on scroll\n * Debounced for performance\n */\n var scrollHandler = function (event) {\n // If there's a timer, cancel it\n if (timeout) {\n window.cancelAnimationFrame(timeout);\n }\n\n // Setup debounce callback\n timeout = window.requestAnimationFrame(publicAPIs.detect);\n };\n\n /**\n * Update content sorting on resize\n * Debounced for performance\n */\n var resizeHandler = function (event) {\n // If there's a timer, cancel it\n if (timeout) {\n window.cancelAnimationFrame(timeout);\n }\n\n // Setup debounce callback\n timeout = window.requestAnimationFrame(function () {\n sortContents(contents);\n publicAPIs.detect();\n });\n };\n\n /**\n * Destroy the current instantiation\n */\n publicAPIs.destroy = function () {\n // Undo DOM changes\n if (current) {\n deactivate(current, settings);\n }\n\n // Remove event listeners\n window.removeEventListener(\"scroll\", scrollHandler, false);\n if (settings.reflow) {\n window.removeEventListener(\"resize\", resizeHandler, false);\n }\n\n // Reset variables\n contents = null;\n navItems = null;\n current = null;\n timeout = null;\n settings = null;\n };\n\n /**\n * Initialize the current instantiation\n */\n var init = function () {\n // Merge user options into defaults\n settings = extend(defaults, options || {});\n\n // Setup variables based on the current DOM\n publicAPIs.setup();\n\n // Find the currently active content\n publicAPIs.detect();\n\n // Setup event listeners\n window.addEventListener(\"scroll\", scrollHandler, false);\n if (settings.reflow) {\n window.addEventListener(\"resize\", resizeHandler, false);\n }\n };\n\n //\n // Initialize and return the public APIs\n //\n\n init();\n return publicAPIs;\n };\n\n //\n // Return the Constructor\n //\n\n return Constructor;\n },\n);\n","// The module cache\nvar __webpack_module_cache__ = {};\n\n// The require function\nfunction __webpack_require__(moduleId) {\n\t// Check if module is in cache\n\tvar cachedModule = __webpack_module_cache__[moduleId];\n\tif (cachedModule !== undefined) {\n\t\treturn cachedModule.exports;\n\t}\n\t// Create a new module (and put it into the cache)\n\tvar module = __webpack_module_cache__[moduleId] = {\n\t\t// no module.id needed\n\t\t// no module.loaded needed\n\t\texports: {}\n\t};\n\n\t// Execute the module function\n\t__webpack_modules__[moduleId].call(module.exports, module, module.exports, __webpack_require__);\n\n\t// Return the exports of the module\n\treturn module.exports;\n}\n\n","// getDefaultExport function for compatibility with non-harmony modules\n__webpack_require__.n = (module) => {\n\tvar getter = module && module.__esModule ?\n\t\t() => (module['default']) :\n\t\t() => (module);\n\t__webpack_require__.d(getter, { a: getter });\n\treturn getter;\n};","// define getter functions for harmony exports\n__webpack_require__.d = (exports, definition) => {\n\tfor(var key in definition) {\n\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n\t\t}\n\t}\n};","__webpack_require__.g = (function() {\n\tif (typeof globalThis === 'object') return globalThis;\n\ttry {\n\t\treturn this || new Function('return this')();\n\t} catch (e) {\n\t\tif (typeof window === 'object') return window;\n\t}\n})();","__webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))","import Gumshoe from \"./gumshoe-patched.js\";\n\n////////////////////////////////////////////////////////////////////////////////\n// Scroll Handling\n////////////////////////////////////////////////////////////////////////////////\nvar tocScroll = null;\nvar header = null;\nvar lastScrollTop = window.pageYOffset || document.documentElement.scrollTop;\nconst GO_TO_TOP_OFFSET = 64;\n\nfunction scrollHandlerForHeader() {\n if (Math.floor(header.getBoundingClientRect().top) == 0) {\n header.classList.add(\"scrolled\");\n } else {\n header.classList.remove(\"scrolled\");\n }\n}\n\nfunction scrollHandlerForBackToTop(positionY) {\n if (positionY < GO_TO_TOP_OFFSET) {\n document.documentElement.classList.remove(\"show-back-to-top\");\n } else {\n if (positionY < lastScrollTop) {\n document.documentElement.classList.add(\"show-back-to-top\");\n } else if (positionY > lastScrollTop) {\n document.documentElement.classList.remove(\"show-back-to-top\");\n }\n }\n lastScrollTop = positionY;\n}\n\nfunction scrollHandlerForTOC(positionY) {\n if (tocScroll === null) {\n return;\n }\n\n // top of page.\n if (positionY == 0) {\n tocScroll.scrollTo(0, 0);\n } else if (\n // bottom of page.\n Math.ceil(positionY) >=\n Math.floor(document.documentElement.scrollHeight - window.innerHeight)\n ) {\n tocScroll.scrollTo(0, tocScroll.scrollHeight);\n } else {\n // somewhere in the middle.\n const current = document.querySelector(\".scroll-current\");\n if (current == null) {\n return;\n }\n\n // https://github.com/pypa/pip/issues/9159 This breaks scroll behaviours.\n // // scroll the currently \"active\" heading in toc, into view.\n // const rect = current.getBoundingClientRect();\n // if (0 > rect.top) {\n // current.scrollIntoView(true); // the argument is \"alignTop\"\n // } else if (rect.bottom > window.innerHeight) {\n // current.scrollIntoView(false);\n // }\n }\n}\n\nfunction scrollHandler(positionY) {\n scrollHandlerForHeader();\n scrollHandlerForBackToTop(positionY);\n scrollHandlerForTOC(positionY);\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Theme Toggle\n////////////////////////////////////////////////////////////////////////////////\nfunction setTheme(mode) {\n if (mode !== \"light\" && mode !== \"dark\" && mode !== \"auto\") {\n console.error(`Got invalid theme mode: ${mode}. Resetting to auto.`);\n mode = \"auto\";\n }\n\n document.body.dataset.theme = mode;\n localStorage.setItem(\"theme\", mode);\n console.log(`Changed to ${mode} mode.`);\n}\n\nfunction cycleThemeOnce() {\n const currentTheme = localStorage.getItem(\"theme\") || \"auto\";\n const prefersDark = window.matchMedia(\"(prefers-color-scheme: dark)\").matches;\n\n if (prefersDark) {\n // Auto (dark) -> Light -> Dark\n if (currentTheme === \"auto\") {\n setTheme(\"light\");\n } else if (currentTheme == \"light\") {\n setTheme(\"dark\");\n } else {\n setTheme(\"auto\");\n }\n } else {\n // Auto (light) -> Dark -> Light\n if (currentTheme === \"auto\") {\n setTheme(\"dark\");\n } else if (currentTheme == \"dark\") {\n setTheme(\"light\");\n } else {\n setTheme(\"auto\");\n }\n }\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Setup\n////////////////////////////////////////////////////////////////////////////////\nfunction setupScrollHandler() {\n // Taken from https://developer.mozilla.org/en-US/docs/Web/API/Document/scroll_event\n let last_known_scroll_position = 0;\n let ticking = false;\n\n window.addEventListener(\"scroll\", function (e) {\n last_known_scroll_position = window.scrollY;\n\n if (!ticking) {\n window.requestAnimationFrame(function () {\n scrollHandler(last_known_scroll_position);\n ticking = false;\n });\n\n ticking = true;\n }\n });\n window.scroll();\n}\n\nfunction setupScrollSpy() {\n if (tocScroll === null) {\n return;\n }\n\n // Scrollspy -- highlight table on contents, based on scroll\n new Gumshoe(\".toc-tree a\", {\n reflow: true,\n recursive: true,\n navClass: \"scroll-current\",\n offset: () => {\n let rem = parseFloat(getComputedStyle(document.documentElement).fontSize);\n return header.getBoundingClientRect().height + 0.5 * rem + 1;\n },\n });\n}\n\nfunction setupTheme() {\n // Attach event handlers for toggling themes\n const buttons = document.getElementsByClassName(\"theme-toggle\");\n Array.from(buttons).forEach((btn) => {\n btn.addEventListener(\"click\", cycleThemeOnce);\n });\n}\n\nfunction setup() {\n setupTheme();\n setupScrollHandler();\n setupScrollSpy();\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Main entrypoint\n////////////////////////////////////////////////////////////////////////////////\nfunction main() {\n document.body.parentNode.classList.remove(\"no-js\");\n\n header = document.querySelector(\"header\");\n tocScroll = document.querySelector(\".toc-scroll\");\n\n setup();\n}\n\ndocument.addEventListener(\"DOMContentLoaded\", main);\n"],"names":["root","g","window","this","defaults","navClass","contentClass","nested","nestedClass","offset","reflow","events","emitEvent","type","elem","detail","settings","event","CustomEvent","bubbles","cancelable","dispatchEvent","getOffsetTop","location","offsetParent","offsetTop","sortContents","contents","sort","item1","item2","content","isInView","bottom","bounds","getBoundingClientRect","parseFloat","getOffset","parseInt","innerHeight","document","documentElement","clientHeight","top","isAtBottom","Math","ceil","pageYOffset","max","body","scrollHeight","offsetHeight","getActive","last","length","item","useLastItem","i","deactivateNested","nav","parentNode","li","closest","classList","remove","deactivate","items","link","activateNested","add","selector","options","navItems","current","timeout","publicAPIs","querySelectorAll","Array","prototype","forEach","call","getElementById","decodeURIComponent","hash","substr","push","active","activate","scrollHandler","cancelAnimationFrame","requestAnimationFrame","detect","resizeHandler","destroy","removeEventListener","merged","arguments","obj","key","hasOwnProperty","extend","setup","addEventListener","factory","__webpack_module_cache__","__webpack_require__","moduleId","cachedModule","undefined","exports","module","__webpack_modules__","n","getter","__esModule","d","a","definition","o","Object","defineProperty","enumerable","get","globalThis","Function","e","prop","tocScroll","header","lastScrollTop","scrollTop","GO_TO_TOP_OFFSET","cycleThemeOnce","currentTheme","localStorage","getItem","mode","matchMedia","matches","console","error","dataset","theme","setItem","log","buttons","getElementsByClassName","from","btn","setupTheme","last_known_scroll_position","ticking","scrollY","positionY","floor","scrollHandlerForBackToTop","scrollTo","querySelector","scrollHandlerForTOC","scroll","setupScrollHandler","recursive","rem","getComputedStyle","fontSize","height"],"sourceRoot":""} \ No newline at end of file diff --git a/_static/searchtools.js b/_static/searchtools.js new file mode 100644 index 0000000..7918c3f --- /dev/null +++ b/_static/searchtools.js @@ -0,0 +1,574 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + `Search finished, found ${resultCount} page(s) matching the search query.` + ); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent !== undefined) return docContent.textContent; + console.warn( + "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + /** + * execute search (requires search index to be loaded) + */ + query: (query) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + // array of [docname, title, anchor, descr, score, filename] + let results = []; + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + results.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id] of foundEntries) { + let score = Math.round(100 * queryLower.length / entry.length) + results.push([ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // lookup as object + objectTerms.forEach((term) => + results.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); + + // now sort the results by score (in opposite order of appearance, since the + // display function below uses pop() to retrieve items) and then + // alphabetically + results.sort((a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; + }); + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + results = results.reverse(); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord) && !terms[word]) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord) && !titleTerms[word]) + arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); + }); + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); + else fileMap.set(file, [word]); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords) => { + const text = Search.htmlToText(htmlText); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/_static/skeleton.css b/_static/skeleton.css new file mode 100644 index 0000000..467c878 --- /dev/null +++ b/_static/skeleton.css @@ -0,0 +1,296 @@ +/* Some sane resets. */ +html { + height: 100%; +} + +body { + margin: 0; + min-height: 100%; +} + +/* All the flexbox magic! */ +body, +.sb-announcement, +.sb-content, +.sb-main, +.sb-container, +.sb-container__inner, +.sb-article-container, +.sb-footer-content, +.sb-header, +.sb-header-secondary, +.sb-footer { + display: flex; +} + +/* These order things vertically */ +body, +.sb-main, +.sb-article-container { + flex-direction: column; +} + +/* Put elements in the center */ +.sb-header, +.sb-header-secondary, +.sb-container, +.sb-content, +.sb-footer, +.sb-footer-content { + justify-content: center; +} +/* Put elements at the ends */ +.sb-article-container { + justify-content: space-between; +} + +/* These elements grow. */ +.sb-main, +.sb-content, +.sb-container, +article { + flex-grow: 1; +} + +/* Because padding making this wider is not fun */ +article { + box-sizing: border-box; +} + +/* The announcements element should never be wider than the page. */ +.sb-announcement { + max-width: 100%; +} + +.sb-sidebar-primary, +.sb-sidebar-secondary { + flex-shrink: 0; + width: 17rem; +} + +.sb-announcement__inner { + justify-content: center; + + box-sizing: border-box; + height: 3rem; + + overflow-x: auto; + white-space: nowrap; +} + +/* Sidebars, with checkbox-based toggle */ +.sb-sidebar-primary, +.sb-sidebar-secondary { + position: fixed; + height: 100%; + top: 0; +} + +.sb-sidebar-primary { + left: -17rem; + transition: left 250ms ease-in-out; +} +.sb-sidebar-secondary { + right: -17rem; + transition: right 250ms ease-in-out; +} + +.sb-sidebar-toggle { + display: none; +} +.sb-sidebar-overlay { + position: fixed; + top: 0; + width: 0; + height: 0; + + transition: width 0ms ease 250ms, height 0ms ease 250ms, opacity 250ms ease; + + opacity: 0; + background-color: rgba(0, 0, 0, 0.54); +} + +#sb-sidebar-toggle--primary:checked + ~ .sb-sidebar-overlay[for="sb-sidebar-toggle--primary"], +#sb-sidebar-toggle--secondary:checked + ~ .sb-sidebar-overlay[for="sb-sidebar-toggle--secondary"] { + width: 100%; + height: 100%; + opacity: 1; + transition: width 0ms ease, height 0ms ease, opacity 250ms ease; +} + +#sb-sidebar-toggle--primary:checked ~ .sb-container .sb-sidebar-primary { + left: 0; +} +#sb-sidebar-toggle--secondary:checked ~ .sb-container .sb-sidebar-secondary { + right: 0; +} + +/* Full-width mode */ +.drop-secondary-sidebar-for-full-width-content + .hide-when-secondary-sidebar-shown { + display: none !important; +} +.drop-secondary-sidebar-for-full-width-content .sb-sidebar-secondary { + display: none !important; +} + +/* Mobile views */ +.sb-page-width { + width: 100%; +} + +.sb-article-container, +.sb-footer-content__inner, +.drop-secondary-sidebar-for-full-width-content .sb-article, +.drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 100vw; +} + +.sb-article, +.match-content-width { + padding: 0 1rem; + box-sizing: border-box; +} + +@media (min-width: 32rem) { + .sb-article, + .match-content-width { + padding: 0 2rem; + } +} + +/* Tablet views */ +@media (min-width: 42rem) { + .sb-article-container { + width: auto; + } + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 42rem; + } + .sb-article, + .match-content-width { + width: 42rem; + } +} +@media (min-width: 46rem) { + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 46rem; + } + .sb-article, + .match-content-width { + width: 46rem; + } +} +@media (min-width: 50rem) { + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 50rem; + } + .sb-article, + .match-content-width { + width: 50rem; + } +} + +/* Tablet views */ +@media (min-width: 59rem) { + .sb-sidebar-secondary { + position: static; + } + .hide-when-secondary-sidebar-shown { + display: none !important; + } + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 59rem; + } + .sb-article, + .match-content-width { + width: 42rem; + } +} +@media (min-width: 63rem) { + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 63rem; + } + .sb-article, + .match-content-width { + width: 46rem; + } +} +@media (min-width: 67rem) { + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 67rem; + } + .sb-article, + .match-content-width { + width: 50rem; + } +} + +/* Desktop views */ +@media (min-width: 76rem) { + .sb-sidebar-primary { + position: static; + } + .hide-when-primary-sidebar-shown { + display: none !important; + } + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 59rem; + } + .sb-article, + .match-content-width { + width: 42rem; + } +} + +/* Full desktop views */ +@media (min-width: 80rem) { + .sb-article, + .match-content-width { + width: 46rem; + } + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 63rem; + } +} + +@media (min-width: 84rem) { + .sb-article, + .match-content-width { + width: 50rem; + } + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 67rem; + } +} + +@media (min-width: 88rem) { + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 67rem; + } + .sb-page-width { + width: 88rem; + } +} diff --git a/_static/sphinx_highlight.js b/_static/sphinx_highlight.js new file mode 100644 index 0000000..8a96c69 --- /dev/null +++ b/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/_static/styles/furo-extensions.css b/_static/styles/furo-extensions.css new file mode 100644 index 0000000..bc447f2 --- /dev/null +++ b/_static/styles/furo-extensions.css @@ -0,0 +1,2 @@ +#furo-sidebar-ad-placement{padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)}#furo-sidebar-ad-placement .ethical-sidebar{background:var(--color-background-secondary);border:none;box-shadow:none}#furo-sidebar-ad-placement .ethical-sidebar:hover{background:var(--color-background-hover)}#furo-sidebar-ad-placement .ethical-sidebar a{color:var(--color-foreground-primary)}#furo-sidebar-ad-placement .ethical-callout a{color:var(--color-foreground-secondary)!important}#furo-readthedocs-versions{background:transparent;display:block;position:static;width:100%}#furo-readthedocs-versions .rst-versions{background:#1a1c1e}#furo-readthedocs-versions .rst-current-version{background:var(--color-sidebar-item-background);cursor:unset}#furo-readthedocs-versions .rst-current-version:hover{background:var(--color-sidebar-item-background)}#furo-readthedocs-versions .rst-current-version .fa-book{color:var(--color-foreground-primary)}#furo-readthedocs-versions>.rst-other-versions{padding:0}#furo-readthedocs-versions>.rst-other-versions small{opacity:1}#furo-readthedocs-versions .injected .rst-versions{position:unset}#furo-readthedocs-versions:focus-within,#furo-readthedocs-versions:hover{box-shadow:0 0 0 1px var(--color-sidebar-background-border)}#furo-readthedocs-versions:focus-within .rst-current-version,#furo-readthedocs-versions:hover .rst-current-version{background:#1a1c1e;font-size:inherit;height:auto;line-height:inherit;padding:12px;text-align:right}#furo-readthedocs-versions:focus-within .rst-current-version .fa-book,#furo-readthedocs-versions:hover .rst-current-version .fa-book{color:#fff;float:left}#furo-readthedocs-versions:focus-within .fa-caret-down,#furo-readthedocs-versions:hover .fa-caret-down{display:none}#furo-readthedocs-versions:focus-within .injected,#furo-readthedocs-versions:focus-within .rst-current-version,#furo-readthedocs-versions:focus-within .rst-other-versions,#furo-readthedocs-versions:hover .injected,#furo-readthedocs-versions:hover .rst-current-version,#furo-readthedocs-versions:hover .rst-other-versions{display:block}#furo-readthedocs-versions:focus-within>.rst-current-version,#furo-readthedocs-versions:hover>.rst-current-version{display:none}.highlight:hover button.copybtn{color:var(--color-code-foreground)}.highlight button.copybtn{align-items:center;background-color:var(--color-code-background);border:none;color:var(--color-background-item);cursor:pointer;height:1.25em;opacity:1;right:.5rem;top:.625rem;transition:color .3s,opacity .3s;width:1.25em}.highlight button.copybtn:hover{background-color:var(--color-code-background);color:var(--color-brand-content)}.highlight button.copybtn:after{background-color:transparent;color:var(--color-code-foreground);display:none}.highlight button.copybtn.success{color:#22863a;transition:color 0ms}.highlight button.copybtn.success:after{display:block}.highlight button.copybtn svg{padding:0}body{--sd-color-primary:var(--color-brand-primary);--sd-color-primary-highlight:var(--color-brand-content);--sd-color-primary-text:var(--color-background-primary);--sd-color-shadow:rgba(0,0,0,.05);--sd-color-card-border:var(--color-card-border);--sd-color-card-border-hover:var(--color-brand-content);--sd-color-card-background:var(--color-card-background);--sd-color-card-text:var(--color-foreground-primary);--sd-color-card-header:var(--color-card-marginals-background);--sd-color-card-footer:var(--color-card-marginals-background);--sd-color-tabs-label-active:var(--color-brand-content);--sd-color-tabs-label-hover:var(--color-foreground-muted);--sd-color-tabs-label-inactive:var(--color-foreground-muted);--sd-color-tabs-underline-active:var(--color-brand-content);--sd-color-tabs-underline-hover:var(--color-foreground-border);--sd-color-tabs-underline-inactive:var(--color-background-border);--sd-color-tabs-overline:var(--color-background-border);--sd-color-tabs-underline:var(--color-background-border)}.sd-tab-content{box-shadow:0 -2px var(--sd-color-tabs-overline),0 1px var(--sd-color-tabs-underline)}.sd-card{box-shadow:0 .1rem .25rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)}.sd-shadow-sm{box-shadow:0 .1rem .25rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-shadow-md{box-shadow:0 .3rem .75rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-shadow-lg{box-shadow:0 .6rem 1.5rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-card-hover:hover{transform:none}.sd-cards-carousel{gap:.25rem;padding:.25rem}body{--tabs--label-text:var(--color-foreground-muted);--tabs--label-text--hover:var(--color-foreground-muted);--tabs--label-text--active:var(--color-brand-content);--tabs--label-text--active--hover:var(--color-brand-content);--tabs--label-background:transparent;--tabs--label-background--hover:transparent;--tabs--label-background--active:transparent;--tabs--label-background--active--hover:transparent;--tabs--padding-x:0.25em;--tabs--margin-x:1em;--tabs--border:var(--color-background-border);--tabs--label-border:transparent;--tabs--label-border--hover:var(--color-foreground-muted);--tabs--label-border--active:var(--color-brand-content);--tabs--label-border--active--hover:var(--color-brand-content)}[role=main] .container{max-width:none;padding-left:0;padding-right:0}.shadow.docutils{border:none;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1)!important}.sphinx-bs .card{background-color:var(--color-background-secondary);color:var(--color-foreground)} +/*# sourceMappingURL=furo-extensions.css.map*/ \ No newline at end of file diff --git a/_static/styles/furo-extensions.css.map b/_static/styles/furo-extensions.css.map new file mode 100644 index 0000000..9ba5637 --- /dev/null +++ b/_static/styles/furo-extensions.css.map @@ -0,0 +1 @@ +{"version":3,"file":"styles/furo-extensions.css","mappings":"AAGA,2BACE,oFACA,4CAKE,6CAHA,YACA,eAEA,CACA,kDACE,yCAEF,8CACE,sCAEJ,8CACE,kDAEJ,2BAGE,uBACA,cAHA,gBACA,UAEA,CAGA,yCACE,mBAEF,gDAEE,gDADA,YACA,CACA,sDACE,gDACF,yDACE,sCAEJ,+CACE,UACA,qDACE,UAGF,mDACE,eAEJ,yEAEE,4DAEA,mHASE,mBAPA,kBAEA,YADA,oBAGA,aADA,gBAIA,CAEA,qIAEE,WADA,UACA,CAEJ,uGACE,aAEF,iUAGE,cAEF,mHACE,aC1EJ,gCACE,mCAEF,0BAKE,mBAUA,8CACA,YAFA,mCAKA,eAZA,cALA,UASA,YADA,YAYA,iCAdA,YAcA,CAEA,gCAEE,8CADA,gCACA,CAEF,gCAGE,6BADA,mCADA,YAEA,CAEF,kCAEE,cADA,oBACA,CACA,wCACE,cAEJ,8BACE,UC5CN,KAEE,6CAA8C,CAC9C,uDAAwD,CACxD,uDAAwD,CAGxD,iCAAsC,CAGtC,+CAAgD,CAChD,uDAAwD,CACxD,uDAAwD,CACxD,oDAAqD,CACrD,6DAA8D,CAC9D,6DAA8D,CAG9D,uDAAwD,CACxD,yDAA0D,CAC1D,4DAA6D,CAC7D,2DAA4D,CAC5D,8DAA+D,CAC/D,iEAAkE,CAClE,uDAAwD,CACxD,wDAAyD,CAG3D,gBACE,qFAGF,SACE,6EAEF,cACE,uFAEF,cACE,uFAEF,cACE,uFAGF,qBACE,eAEF,mBACE,WACA,eChDF,KACE,gDAAiD,CACjD,uDAAwD,CACxD,qDAAsD,CACtD,4DAA6D,CAC7D,oCAAqC,CACrC,2CAA4C,CAC5C,4CAA6C,CAC7C,mDAAoD,CACpD,wBAAyB,CACzB,oBAAqB,CACrB,6CAA8C,CAC9C,gCAAiC,CACjC,yDAA0D,CAC1D,uDAAwD,CACxD,8DAA+D,CCbjE,uBACE,eACA,eACA,gBAGF,iBACE,YACA,+EAGF,iBACE,mDACA","sources":["webpack:///./src/furo/assets/styles/extensions/_readthedocs.sass","webpack:///./src/furo/assets/styles/extensions/_copybutton.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-design.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-inline-tabs.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-panels.sass"],"sourcesContent":["// This file contains the styles used for tweaking how ReadTheDoc's embedded\n// contents would show up inside the theme.\n\n#furo-sidebar-ad-placement\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n .ethical-sidebar\n // Remove the border and box-shadow.\n border: none\n box-shadow: none\n // Manage the background colors.\n background: var(--color-background-secondary)\n &:hover\n background: var(--color-background-hover)\n // Ensure the text is legible.\n a\n color: var(--color-foreground-primary)\n\n .ethical-callout a\n color: var(--color-foreground-secondary) !important\n\n#furo-readthedocs-versions\n position: static\n width: 100%\n background: transparent\n display: block\n\n // Make the background color fit with the theme's aesthetic.\n .rst-versions\n background: rgb(26, 28, 30)\n\n .rst-current-version\n cursor: unset\n background: var(--color-sidebar-item-background)\n &:hover\n background: var(--color-sidebar-item-background)\n .fa-book\n color: var(--color-foreground-primary)\n\n > .rst-other-versions\n padding: 0\n small\n opacity: 1\n\n .injected\n .rst-versions\n position: unset\n\n &:hover,\n &:focus-within\n box-shadow: 0 0 0 1px var(--color-sidebar-background-border)\n\n .rst-current-version\n // Undo the tweaks done in RTD's CSS\n font-size: inherit\n line-height: inherit\n height: auto\n text-align: right\n padding: 12px\n\n // Match the rest of the body\n background: #1a1c1e\n\n .fa-book\n float: left\n color: white\n\n .fa-caret-down\n display: none\n\n .rst-current-version,\n .rst-other-versions,\n .injected\n display: block\n\n > .rst-current-version\n display: none\n",".highlight\n &:hover button.copybtn\n color: var(--color-code-foreground)\n\n button.copybtn\n // Make it visible\n opacity: 1\n\n // Align things correctly\n align-items: center\n\n height: 1.25em\n width: 1.25em\n\n top: 0.625rem // $code-spacing-vertical\n right: 0.5rem\n\n // Make it look better\n color: var(--color-background-item)\n background-color: var(--color-code-background)\n border: none\n\n // Change to cursor to make it obvious that you can click on it\n cursor: pointer\n\n // Transition smoothly, for aesthetics\n transition: color 300ms, opacity 300ms\n\n &:hover\n color: var(--color-brand-content)\n background-color: var(--color-code-background)\n\n &::after\n display: none\n color: var(--color-code-foreground)\n background-color: transparent\n\n &.success\n transition: color 0ms\n color: #22863a\n &::after\n display: block\n\n svg\n padding: 0\n","body\n // Colors\n --sd-color-primary: var(--color-brand-primary)\n --sd-color-primary-highlight: var(--color-brand-content)\n --sd-color-primary-text: var(--color-background-primary)\n\n // Shadows\n --sd-color-shadow: rgba(0, 0, 0, 0.05)\n\n // Cards\n --sd-color-card-border: var(--color-card-border)\n --sd-color-card-border-hover: var(--color-brand-content)\n --sd-color-card-background: var(--color-card-background)\n --sd-color-card-text: var(--color-foreground-primary)\n --sd-color-card-header: var(--color-card-marginals-background)\n --sd-color-card-footer: var(--color-card-marginals-background)\n\n // Tabs\n --sd-color-tabs-label-active: var(--color-brand-content)\n --sd-color-tabs-label-hover: var(--color-foreground-muted)\n --sd-color-tabs-label-inactive: var(--color-foreground-muted)\n --sd-color-tabs-underline-active: var(--color-brand-content)\n --sd-color-tabs-underline-hover: var(--color-foreground-border)\n --sd-color-tabs-underline-inactive: var(--color-background-border)\n --sd-color-tabs-overline: var(--color-background-border)\n --sd-color-tabs-underline: var(--color-background-border)\n\n// Tabs\n.sd-tab-content\n box-shadow: 0 -2px var(--sd-color-tabs-overline), 0 1px var(--sd-color-tabs-underline)\n\n// Shadows\n.sd-card // Have a shadow by default\n box-shadow: 0 0.1rem 0.25rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1)\n\n.sd-shadow-sm\n box-shadow: 0 0.1rem 0.25rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n.sd-shadow-md\n box-shadow: 0 0.3rem 0.75rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n.sd-shadow-lg\n box-shadow: 0 0.6rem 1.5rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n// Cards\n.sd-card-hover:hover // Don't change scale on hover\n transform: none\n\n.sd-cards-carousel // Have a bit of gap in the carousel by default\n gap: 0.25rem\n padding: 0.25rem\n","// This file contains styles to tweak sphinx-inline-tabs to work well with Furo.\n\nbody\n --tabs--label-text: var(--color-foreground-muted)\n --tabs--label-text--hover: var(--color-foreground-muted)\n --tabs--label-text--active: var(--color-brand-content)\n --tabs--label-text--active--hover: var(--color-brand-content)\n --tabs--label-background: transparent\n --tabs--label-background--hover: transparent\n --tabs--label-background--active: transparent\n --tabs--label-background--active--hover: transparent\n --tabs--padding-x: 0.25em\n --tabs--margin-x: 1em\n --tabs--border: var(--color-background-border)\n --tabs--label-border: transparent\n --tabs--label-border--hover: var(--color-foreground-muted)\n --tabs--label-border--active: var(--color-brand-content)\n --tabs--label-border--active--hover: var(--color-brand-content)\n","// This file contains styles to tweak sphinx-panels to work well with Furo.\n\n// sphinx-panels includes Bootstrap 4, which uses .container which can conflict\n// with docutils' `.. container::` directive.\n[role=\"main\"] .container\n max-width: initial\n padding-left: initial\n padding-right: initial\n\n// Make the panels look nicer!\n.shadow.docutils\n border: none\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n// Make panel colors respond to dark mode\n.sphinx-bs .card\n background-color: var(--color-background-secondary)\n color: var(--color-foreground)\n"],"names":[],"sourceRoot":""} \ No newline at end of file diff --git a/_static/styles/furo.css b/_static/styles/furo.css new file mode 100644 index 0000000..3d29a21 --- /dev/null +++ b/_static/styles/furo.css @@ -0,0 +1,2 @@ +/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */html{-webkit-text-size-adjust:100%;line-height:1.15}body{margin:0}main{display:block}h1{font-size:2em;margin:.67em 0}hr{box-sizing:content-box;height:0;overflow:visible}pre{font-family:monospace,monospace;font-size:1em}a{background-color:transparent}abbr[title]{border-bottom:none;text-decoration:underline;text-decoration:underline dotted}b,strong{font-weight:bolder}code,kbd,samp{font-family:monospace,monospace;font-size:1em}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}img{border-style:none}button,input,optgroup,select,textarea{font-family:inherit;font-size:100%;line-height:1.15;margin:0}button,input{overflow:visible}button,select{text-transform:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner,button::-moz-focus-inner{border-style:none;padding:0}[type=button]:-moz-focusring,[type=reset]:-moz-focusring,[type=submit]:-moz-focusring,button:-moz-focusring{outline:1px dotted ButtonText}fieldset{padding:.35em .75em .625em}legend{box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{vertical-align:baseline}textarea{overflow:auto}[type=checkbox],[type=radio]{box-sizing:border-box;padding:0}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}details{display:block}summary{display:list-item}[hidden],template{display:none}@media print{.content-icon-container,.headerlink,.mobile-header,.related-pages{display:none!important}.highlight{border:.1pt solid var(--color-foreground-border)}a,blockquote,dl,ol,pre,table,ul{page-break-inside:avoid}caption,figure,h1,h2,h3,h4,h5,h6,img{page-break-after:avoid;page-break-inside:avoid}dl,ol,ul{page-break-before:avoid}}.visually-hidden{clip:rect(0,0,0,0)!important;border:0!important;height:1px!important;margin:-1px!important;overflow:hidden!important;padding:0!important;position:absolute!important;white-space:nowrap!important;width:1px!important}:-moz-focusring{outline:auto}body{--font-stack:-apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji;--font-stack--monospace:"SFMono-Regular",Menlo,Consolas,Monaco,Liberation Mono,Lucida Console,monospace;--font-size--normal:100%;--font-size--small:87.5%;--font-size--small--2:81.25%;--font-size--small--3:75%;--font-size--small--4:62.5%;--sidebar-caption-font-size:var(--font-size--small--2);--sidebar-item-font-size:var(--font-size--small);--sidebar-search-input-font-size:var(--font-size--small);--toc-font-size:var(--font-size--small--3);--toc-font-size--mobile:var(--font-size--normal);--toc-title-font-size:var(--font-size--small--4);--admonition-font-size:0.8125rem;--admonition-title-font-size:0.8125rem;--code-font-size:var(--font-size--small--2);--api-font-size:var(--font-size--small);--header-height:calc(var(--sidebar-item-line-height) + var(--sidebar-item-spacing-vertical)*4);--header-padding:0.5rem;--sidebar-tree-space-above:1.5rem;--sidebar-caption-space-above:1rem;--sidebar-item-line-height:1rem;--sidebar-item-spacing-vertical:0.5rem;--sidebar-item-spacing-horizontal:1rem;--sidebar-item-height:calc(var(--sidebar-item-line-height) + var(--sidebar-item-spacing-vertical)*2);--sidebar-expander-width:var(--sidebar-item-height);--sidebar-search-space-above:0.5rem;--sidebar-search-input-spacing-vertical:0.5rem;--sidebar-search-input-spacing-horizontal:0.5rem;--sidebar-search-input-height:1rem;--sidebar-search-icon-size:var(--sidebar-search-input-height);--toc-title-padding:0.25rem 0;--toc-spacing-vertical:1.5rem;--toc-spacing-horizontal:1.5rem;--toc-item-spacing-vertical:0.4rem;--toc-item-spacing-horizontal:1rem;--icon-search:url('data:image/svg+xml;charset=utf-8,');--icon-pencil:url('data:image/svg+xml;charset=utf-8,');--icon-abstract:url('data:image/svg+xml;charset=utf-8,');--icon-info:url('data:image/svg+xml;charset=utf-8,');--icon-flame:url('data:image/svg+xml;charset=utf-8,');--icon-question:url('data:image/svg+xml;charset=utf-8,');--icon-warning:url('data:image/svg+xml;charset=utf-8,');--icon-failure:url('data:image/svg+xml;charset=utf-8,');--icon-spark:url('data:image/svg+xml;charset=utf-8,');--color-admonition-title--caution:#ff9100;--color-admonition-title-background--caution:rgba(255,145,0,.2);--color-admonition-title--warning:#ff9100;--color-admonition-title-background--warning:rgba(255,145,0,.2);--color-admonition-title--danger:#ff5252;--color-admonition-title-background--danger:rgba(255,82,82,.2);--color-admonition-title--attention:#ff5252;--color-admonition-title-background--attention:rgba(255,82,82,.2);--color-admonition-title--error:#ff5252;--color-admonition-title-background--error:rgba(255,82,82,.2);--color-admonition-title--hint:#00c852;--color-admonition-title-background--hint:rgba(0,200,82,.2);--color-admonition-title--tip:#00c852;--color-admonition-title-background--tip:rgba(0,200,82,.2);--color-admonition-title--important:#00bfa5;--color-admonition-title-background--important:rgba(0,191,165,.2);--color-admonition-title--note:#00b0ff;--color-admonition-title-background--note:rgba(0,176,255,.2);--color-admonition-title--seealso:#448aff;--color-admonition-title-background--seealso:rgba(68,138,255,.2);--color-admonition-title--admonition-todo:grey;--color-admonition-title-background--admonition-todo:hsla(0,0%,50%,.2);--color-admonition-title:#651fff;--color-admonition-title-background:rgba(101,31,255,.2);--icon-admonition-default:var(--icon-abstract);--color-topic-title:#14b8a6;--color-topic-title-background:rgba(20,184,166,.2);--icon-topic-default:var(--icon-pencil);--color-problematic:#b30000;--color-foreground-primary:#000;--color-foreground-secondary:#5a5c63;--color-foreground-muted:#646776;--color-foreground-border:#878787;--color-background-primary:#fff;--color-background-secondary:#f8f9fb;--color-background-hover:#efeff4;--color-background-hover--transparent:#efeff400;--color-background-border:#eeebee;--color-background-item:#ccc;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#2962ff;--color-brand-content:#2a5adf;--color-api-background:var(--color-background-hover--transparent);--color-api-background-hover:var(--color-background-hover);--color-api-overall:var(--color-foreground-secondary);--color-api-name:var(--color-problematic);--color-api-pre-name:var(--color-problematic);--color-api-paren:var(--color-foreground-secondary);--color-api-keyword:var(--color-foreground-primary);--color-highlight-on-target:#ffc;--color-inline-code-background:var(--color-background-secondary);--color-highlighted-background:#def;--color-highlighted-text:var(--color-foreground-primary);--color-guilabel-background:#ddeeff80;--color-guilabel-border:#bedaf580;--color-guilabel-text:var(--color-foreground-primary);--color-admonition-background:transparent;--color-table-header-background:var(--color-background-secondary);--color-table-border:var(--color-background-border);--color-card-border:var(--color-background-secondary);--color-card-background:transparent;--color-card-marginals-background:var(--color-background-secondary);--color-header-background:var(--color-background-primary);--color-header-border:var(--color-background-border);--color-header-text:var(--color-foreground-primary);--color-sidebar-background:var(--color-background-secondary);--color-sidebar-background-border:var(--color-background-border);--color-sidebar-brand-text:var(--color-foreground-primary);--color-sidebar-caption-text:var(--color-foreground-muted);--color-sidebar-link-text:var(--color-foreground-secondary);--color-sidebar-link-text--top-level:var(--color-brand-primary);--color-sidebar-item-background:var(--color-sidebar-background);--color-sidebar-item-background--current:var( --color-sidebar-item-background );--color-sidebar-item-background--hover:linear-gradient(90deg,var(--color-background-hover--transparent) 0%,var(--color-background-hover) var(--sidebar-item-spacing-horizontal),var(--color-background-hover) 100%);--color-sidebar-item-expander-background:transparent;--color-sidebar-item-expander-background--hover:var( --color-background-hover );--color-sidebar-search-text:var(--color-foreground-primary);--color-sidebar-search-background:var(--color-background-secondary);--color-sidebar-search-background--focus:var(--color-background-primary);--color-sidebar-search-border:var(--color-background-border);--color-sidebar-search-icon:var(--color-foreground-muted);--color-toc-background:var(--color-background-primary);--color-toc-title-text:var(--color-foreground-muted);--color-toc-item-text:var(--color-foreground-secondary);--color-toc-item-text--hover:var(--color-foreground-primary);--color-toc-item-text--active:var(--color-brand-primary);--color-content-foreground:var(--color-foreground-primary);--color-content-background:transparent;--color-link:var(--color-brand-content);--color-link--hover:var(--color-brand-content);--color-link-underline:var(--color-background-border);--color-link-underline--hover:var(--color-foreground-border)}.only-light{display:block!important}html body .only-dark{display:none!important}@media not print{body[data-theme=dark]{--color-problematic:#ee5151;--color-foreground-primary:#ffffffcc;--color-foreground-secondary:#9ca0a5;--color-foreground-muted:#81868d;--color-foreground-border:#666;--color-background-primary:#131416;--color-background-secondary:#1a1c1e;--color-background-hover:#1e2124;--color-background-hover--transparent:#1e212400;--color-background-border:#303335;--color-background-item:#444;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#2b8cee;--color-brand-content:#368ce2;--color-highlighted-background:#083563;--color-guilabel-background:#08356380;--color-guilabel-border:#13395f80;--color-api-keyword:var(--color-foreground-secondary);--color-highlight-on-target:#330;--color-admonition-background:#18181a;--color-card-border:var(--color-background-secondary);--color-card-background:#18181a;--color-card-marginals-background:var(--color-background-hover)}html body[data-theme=dark] .only-light{display:none!important}body[data-theme=dark] .only-dark{display:block!important}@media(prefers-color-scheme:dark){body:not([data-theme=light]){--color-problematic:#ee5151;--color-foreground-primary:#ffffffcc;--color-foreground-secondary:#9ca0a5;--color-foreground-muted:#81868d;--color-foreground-border:#666;--color-background-primary:#131416;--color-background-secondary:#1a1c1e;--color-background-hover:#1e2124;--color-background-hover--transparent:#1e212400;--color-background-border:#303335;--color-background-item:#444;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#2b8cee;--color-brand-content:#368ce2;--color-highlighted-background:#083563;--color-guilabel-background:#08356380;--color-guilabel-border:#13395f80;--color-api-keyword:var(--color-foreground-secondary);--color-highlight-on-target:#330;--color-admonition-background:#18181a;--color-card-border:var(--color-background-secondary);--color-card-background:#18181a;--color-card-marginals-background:var(--color-background-hover)}html body:not([data-theme=light]) .only-light{display:none!important}body:not([data-theme=light]) .only-dark{display:block!important}}}body[data-theme=auto] .theme-toggle svg.theme-icon-when-auto,body[data-theme=dark] .theme-toggle svg.theme-icon-when-dark,body[data-theme=light] .theme-toggle svg.theme-icon-when-light{display:block}body{font-family:var(--font-stack)}code,kbd,pre,samp{font-family:var(--font-stack--monospace)}body{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}article{line-height:1.5}h1,h2,h3,h4,h5,h6{border-radius:.5rem;font-weight:700;line-height:1.25;margin:.5rem -.5rem;padding-left:.5rem;padding-right:.5rem}h1+p,h2+p,h3+p,h4+p,h5+p,h6+p{margin-top:0}h1{font-size:2.5em;margin-bottom:1rem}h1,h2{margin-top:1.75rem}h2{font-size:2em}h3{font-size:1.5em}h4{font-size:1.25em}h5{font-size:1.125em}h6{font-size:1em}small{font-size:80%;opacity:75%}p{margin-bottom:.75rem;margin-top:.5rem}hr.docutils{background-color:var(--color-background-border);border:0;height:1px;margin:2rem 0;padding:0}.centered{text-align:center}a{color:var(--color-link);text-decoration:underline;text-decoration-color:var(--color-link-underline)}a:hover{color:var(--color-link--hover);text-decoration-color:var(--color-link-underline--hover)}a.muted-link{color:inherit}a.muted-link:hover{color:var(--color-link);text-decoration-color:var(--color-link-underline--hover)}html{overflow-x:hidden;overflow-y:scroll;scroll-behavior:smooth}.sidebar-scroll,.toc-scroll,article[role=main] *{scrollbar-color:var(--color-foreground-border) transparent;scrollbar-width:thin}.sidebar-scroll::-webkit-scrollbar,.toc-scroll::-webkit-scrollbar,article[role=main] ::-webkit-scrollbar{height:.25rem;width:.25rem}.sidebar-scroll::-webkit-scrollbar-thumb,.toc-scroll::-webkit-scrollbar-thumb,article[role=main] ::-webkit-scrollbar-thumb{background-color:var(--color-foreground-border);border-radius:.125rem}body,html{background:var(--color-background-primary);color:var(--color-foreground-primary);height:100%}article{background:var(--color-content-background);color:var(--color-content-foreground);overflow-wrap:break-word}.page{display:flex;min-height:100%}.mobile-header{background-color:var(--color-header-background);border-bottom:1px solid var(--color-header-border);color:var(--color-header-text);display:none;height:var(--header-height);width:100%;z-index:10}.mobile-header.scrolled{border-bottom:none;box-shadow:0 0 .2rem rgba(0,0,0,.1),0 .2rem .4rem rgba(0,0,0,.2)}.mobile-header .header-center a{color:var(--color-header-text);text-decoration:none}.main{display:flex;flex:1}.sidebar-drawer{background:var(--color-sidebar-background);border-right:1px solid var(--color-sidebar-background-border);box-sizing:border-box;display:flex;justify-content:flex-end;min-width:15em;width:calc(50% - 26em)}.sidebar-container,.toc-drawer{box-sizing:border-box;width:15em}.toc-drawer{background:var(--color-toc-background);padding-right:1rem}.sidebar-sticky,.toc-sticky{display:flex;flex-direction:column;height:min(100%,100vh);height:100vh;position:sticky;top:0}.sidebar-scroll,.toc-scroll{flex-grow:1;flex-shrink:1;overflow:auto;scroll-behavior:smooth}.content{display:flex;flex-direction:column;justify-content:space-between;padding:0 3em;width:46em}.icon{display:inline-block;height:1rem;width:1rem}.icon svg{height:100%;width:100%}.announcement{align-items:center;background-color:var(--color-announcement-background);color:var(--color-announcement-text);display:flex;height:var(--header-height);overflow-x:auto}.announcement+.page{min-height:calc(100% - var(--header-height))}.announcement-content{box-sizing:border-box;min-width:100%;padding:.5rem;text-align:center;white-space:nowrap}.announcement-content a{color:var(--color-announcement-text);text-decoration-color:var(--color-announcement-text)}.announcement-content a:hover{color:var(--color-announcement-text);text-decoration-color:var(--color-link--hover)}.no-js .theme-toggle-container{display:none}.theme-toggle-container{vertical-align:middle}.theme-toggle{background:transparent;border:none;cursor:pointer;padding:0}.theme-toggle svg{color:var(--color-foreground-primary);display:none;height:1rem;vertical-align:middle;width:1rem}.theme-toggle-header{float:left;padding:1rem .5rem}.nav-overlay-icon,.toc-overlay-icon{cursor:pointer;display:none}.nav-overlay-icon .icon,.toc-overlay-icon .icon{color:var(--color-foreground-secondary);height:1rem;width:1rem}.nav-overlay-icon,.toc-header-icon{align-items:center;justify-content:center}.toc-content-icon{height:1.5rem;width:1.5rem}.content-icon-container{display:flex;float:right;gap:.5rem;margin-bottom:1rem;margin-left:1rem;margin-top:1.5rem}.content-icon-container .edit-this-page svg{color:inherit;height:1rem;width:1rem}.sidebar-toggle{display:none;position:absolute}.sidebar-toggle[name=__toc]{left:20px}.sidebar-toggle:checked{left:40px}.overlay{background-color:rgba(0,0,0,.54);height:0;opacity:0;position:fixed;top:0;transition:width 0ms,height 0ms,opacity .25s ease-out;width:0}.sidebar-overlay{z-index:20}.toc-overlay{z-index:40}.sidebar-drawer{transition:left .25s ease-in-out;z-index:30}.toc-drawer{transition:right .25s ease-in-out;z-index:50}#__navigation:checked~.sidebar-overlay{height:100%;opacity:1;width:100%}#__navigation:checked~.page .sidebar-drawer{left:0;top:0}#__toc:checked~.toc-overlay{height:100%;opacity:1;width:100%}#__toc:checked~.page .toc-drawer{right:0;top:0}.back-to-top{background:var(--color-background-primary);border-radius:1rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 1px 0 hsla(220,9%,46%,.502);display:none;font-size:.8125rem;left:0;margin-left:50%;padding:.5rem .75rem .5rem .5rem;position:fixed;text-decoration:none;top:1rem;transform:translateX(-50%);z-index:10}.back-to-top svg{fill:currentColor;display:inline-block;height:1rem;width:1rem}.back-to-top span{margin-left:.25rem}.show-back-to-top .back-to-top{align-items:center;display:flex}@media(min-width:97em){html{font-size:110%}}@media(max-width:82em){.toc-content-icon{display:flex}.toc-drawer{border-left:1px solid var(--color-background-muted);height:100vh;position:fixed;right:-15em;top:0}.toc-tree{border-left:none;font-size:var(--toc-font-size--mobile)}.sidebar-drawer{width:calc(50% - 18.5em)}}@media(max-width:67em){.nav-overlay-icon{display:flex}.sidebar-drawer{height:100vh;left:-15em;position:fixed;top:0;width:15em}.toc-header-icon{display:flex}.theme-toggle-content,.toc-content-icon{display:none}.theme-toggle-header{display:block}.mobile-header{align-items:center;display:flex;justify-content:space-between;position:sticky;top:0}.mobile-header .header-left,.mobile-header .header-right{display:flex;height:var(--header-height);padding:0 var(--header-padding)}.mobile-header .header-left label,.mobile-header .header-right label{height:100%;-webkit-user-select:none;-moz-user-select:none;user-select:none;width:100%}.nav-overlay-icon .icon,.theme-toggle svg{height:1.25rem;width:1.25rem}:target{scroll-margin-top:var(--header-height)}.back-to-top{top:calc(var(--header-height) + .5rem)}.page{flex-direction:column;justify-content:center}.content{margin-left:auto;margin-right:auto}}@media(max-width:52em){.content{overflow-x:auto;width:100%}}@media(max-width:46em){.content{padding:0 1em}article aside.sidebar{float:none;margin:1rem 0;width:100%}}.admonition,.topic{background:var(--color-admonition-background);border-radius:.2rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1);font-size:var(--admonition-font-size);margin:1rem auto;overflow:hidden;padding:0 .5rem .5rem;page-break-inside:avoid}.admonition>:nth-child(2),.topic>:nth-child(2){margin-top:0}.admonition>:last-child,.topic>:last-child{margin-bottom:0}.admonition p.admonition-title,p.topic-title{font-size:var(--admonition-title-font-size);font-weight:500;line-height:1.3;margin:0 -.5rem .5rem;padding:.4rem .5rem .4rem 2rem;position:relative}.admonition p.admonition-title:before,p.topic-title:before{content:"";height:1rem;left:.5rem;position:absolute;width:1rem}p.admonition-title{background-color:var(--color-admonition-title-background)}p.admonition-title:before{background-color:var(--color-admonition-title);-webkit-mask-image:var(--icon-admonition-default);mask-image:var(--icon-admonition-default);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}p.topic-title{background-color:var(--color-topic-title-background)}p.topic-title:before{background-color:var(--color-topic-title);-webkit-mask-image:var(--icon-topic-default);mask-image:var(--icon-topic-default);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.admonition{border-left:.2rem solid var(--color-admonition-title)}.admonition.caution{border-left-color:var(--color-admonition-title--caution)}.admonition.caution>.admonition-title{background-color:var(--color-admonition-title-background--caution)}.admonition.caution>.admonition-title:before{background-color:var(--color-admonition-title--caution);-webkit-mask-image:var(--icon-spark);mask-image:var(--icon-spark)}.admonition.warning{border-left-color:var(--color-admonition-title--warning)}.admonition.warning>.admonition-title{background-color:var(--color-admonition-title-background--warning)}.admonition.warning>.admonition-title:before{background-color:var(--color-admonition-title--warning);-webkit-mask-image:var(--icon-warning);mask-image:var(--icon-warning)}.admonition.danger{border-left-color:var(--color-admonition-title--danger)}.admonition.danger>.admonition-title{background-color:var(--color-admonition-title-background--danger)}.admonition.danger>.admonition-title:before{background-color:var(--color-admonition-title--danger);-webkit-mask-image:var(--icon-spark);mask-image:var(--icon-spark)}.admonition.attention{border-left-color:var(--color-admonition-title--attention)}.admonition.attention>.admonition-title{background-color:var(--color-admonition-title-background--attention)}.admonition.attention>.admonition-title:before{background-color:var(--color-admonition-title--attention);-webkit-mask-image:var(--icon-warning);mask-image:var(--icon-warning)}.admonition.error{border-left-color:var(--color-admonition-title--error)}.admonition.error>.admonition-title{background-color:var(--color-admonition-title-background--error)}.admonition.error>.admonition-title:before{background-color:var(--color-admonition-title--error);-webkit-mask-image:var(--icon-failure);mask-image:var(--icon-failure)}.admonition.hint{border-left-color:var(--color-admonition-title--hint)}.admonition.hint>.admonition-title{background-color:var(--color-admonition-title-background--hint)}.admonition.hint>.admonition-title:before{background-color:var(--color-admonition-title--hint);-webkit-mask-image:var(--icon-question);mask-image:var(--icon-question)}.admonition.tip{border-left-color:var(--color-admonition-title--tip)}.admonition.tip>.admonition-title{background-color:var(--color-admonition-title-background--tip)}.admonition.tip>.admonition-title:before{background-color:var(--color-admonition-title--tip);-webkit-mask-image:var(--icon-info);mask-image:var(--icon-info)}.admonition.important{border-left-color:var(--color-admonition-title--important)}.admonition.important>.admonition-title{background-color:var(--color-admonition-title-background--important)}.admonition.important>.admonition-title:before{background-color:var(--color-admonition-title--important);-webkit-mask-image:var(--icon-flame);mask-image:var(--icon-flame)}.admonition.note{border-left-color:var(--color-admonition-title--note)}.admonition.note>.admonition-title{background-color:var(--color-admonition-title-background--note)}.admonition.note>.admonition-title:before{background-color:var(--color-admonition-title--note);-webkit-mask-image:var(--icon-pencil);mask-image:var(--icon-pencil)}.admonition.seealso{border-left-color:var(--color-admonition-title--seealso)}.admonition.seealso>.admonition-title{background-color:var(--color-admonition-title-background--seealso)}.admonition.seealso>.admonition-title:before{background-color:var(--color-admonition-title--seealso);-webkit-mask-image:var(--icon-info);mask-image:var(--icon-info)}.admonition.admonition-todo{border-left-color:var(--color-admonition-title--admonition-todo)}.admonition.admonition-todo>.admonition-title{background-color:var(--color-admonition-title-background--admonition-todo)}.admonition.admonition-todo>.admonition-title:before{background-color:var(--color-admonition-title--admonition-todo);-webkit-mask-image:var(--icon-pencil);mask-image:var(--icon-pencil)}.admonition-todo>.admonition-title{text-transform:uppercase}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd{margin-left:2rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd>:first-child{margin-top:.125rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list,dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd>:last-child{margin-bottom:.75rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list>dt{font-size:var(--font-size--small);text-transform:uppercase}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd:empty{margin-bottom:.5rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul{margin-left:-1.2rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul>li>p:nth-child(2){margin-top:0}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul>li>p+p:last-child:empty{margin-bottom:0;margin-top:0}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt{color:var(--color-api-overall)}.sig:not(.sig-inline){background:var(--color-api-background);border-radius:.25rem;font-family:var(--font-stack--monospace);font-size:var(--api-font-size);font-weight:700;margin-left:-.25rem;margin-right:-.25rem;padding:.25rem .5rem .25rem 3em;text-indent:-2.5em;transition:background .1s ease-out}.sig:not(.sig-inline):hover{background:var(--color-api-background-hover)}.sig:not(.sig-inline) a.reference .viewcode-link{font-weight:400;width:3.5rem}em.property{font-style:normal}em.property:first-child{color:var(--color-api-keyword)}.sig-name{color:var(--color-api-name)}.sig-prename{color:var(--color-api-pre-name);font-weight:400}.sig-paren{color:var(--color-api-paren)}.sig-param{font-style:normal}.versionmodified{font-style:italic}div.deprecated p,div.versionadded p,div.versionchanged p{margin-bottom:.125rem;margin-top:.125rem}.viewcode-back,.viewcode-link{float:right;text-align:right}.line-block{margin-bottom:.75rem;margin-top:.5rem}.line-block .line-block{margin-bottom:0;margin-top:0;padding-left:1rem}.code-block-caption,article p.caption,table>caption{font-size:var(--font-size--small);text-align:center}.toctree-wrapper.compound .caption,.toctree-wrapper.compound :not(.caption)>.caption-text{font-size:var(--font-size--small);margin-bottom:0;text-align:initial;text-transform:uppercase}.toctree-wrapper.compound>ul{margin-bottom:0;margin-top:0}.sig-inline,code.literal{background:var(--color-inline-code-background);border-radius:.2em;font-size:var(--font-size--small--2);padding:.1em .2em}pre.literal-block .sig-inline,pre.literal-block code.literal{font-size:inherit;padding:0}p .sig-inline,p code.literal{border:1px solid var(--color-background-border)}.sig-inline{font-family:var(--font-stack--monospace)}div[class*=" highlight-"],div[class^=highlight-]{display:flex;margin:1em 0}div[class*=" highlight-"] .table-wrapper,div[class^=highlight-] .table-wrapper,pre{margin:0;padding:0}pre{overflow:auto}article[role=main] .highlight pre{line-height:1.5}.highlight pre,pre.literal-block{font-size:var(--code-font-size);padding:.625rem .875rem}pre.literal-block{background-color:var(--color-code-background);border-radius:.2rem;color:var(--color-code-foreground);margin-bottom:1rem;margin-top:1rem}.highlight{border-radius:.2rem;width:100%}.highlight .gp,.highlight span.linenos{pointer-events:none;-webkit-user-select:none;-moz-user-select:none;user-select:none}.highlight .hll{display:block;margin-left:-.875rem;margin-right:-.875rem;padding-left:.875rem;padding-right:.875rem}.code-block-caption{background-color:var(--color-code-background);border-bottom:1px solid;border-radius:.25rem;border-bottom-left-radius:0;border-bottom-right-radius:0;border-color:var(--color-background-border);color:var(--color-code-foreground);display:flex;font-weight:300;padding:.625rem .875rem}.code-block-caption+div[class]{margin-top:0}.code-block-caption+div[class] pre{border-top-left-radius:0;border-top-right-radius:0}.highlighttable{display:block;width:100%}.highlighttable tbody{display:block}.highlighttable tr{display:flex}.highlighttable td.linenos{background-color:var(--color-code-background);border-bottom-left-radius:.2rem;border-top-left-radius:.2rem;color:var(--color-code-foreground);padding:.625rem 0 .625rem .875rem}.highlighttable .linenodiv{box-shadow:-.0625rem 0 var(--color-foreground-border) inset;font-size:var(--code-font-size);padding-right:.875rem}.highlighttable td.code{display:block;flex:1;overflow:hidden;padding:0}.highlighttable td.code .highlight{border-bottom-left-radius:0;border-top-left-radius:0}.highlight span.linenos{box-shadow:-.0625rem 0 var(--color-foreground-border) inset;display:inline-block;margin-right:.875rem;padding-left:0;padding-right:.875rem}.footnote-reference{font-size:var(--font-size--small--4);vertical-align:super}dl.footnote.brackets{color:var(--color-foreground-secondary);display:grid;font-size:var(--font-size--small);grid-template-columns:max-content auto}dl.footnote.brackets dt{margin:0}dl.footnote.brackets dt>.fn-backref{margin-left:.25rem}dl.footnote.brackets dt:after{content:":"}dl.footnote.brackets dt .brackets:before{content:"["}dl.footnote.brackets dt .brackets:after{content:"]"}dl.footnote.brackets dd{margin:0;padding:0 1rem}aside.footnote{color:var(--color-foreground-secondary);font-size:var(--font-size--small)}aside.footnote>span,div.citation>span{float:left;font-weight:500;padding-right:.25rem}aside.footnote>p,div.citation>p{margin-left:2rem}img{box-sizing:border-box;height:auto;max-width:100%}article .figure,article figure{border-radius:.2rem;margin:0}article .figure :last-child,article figure :last-child{margin-bottom:0}article .align-left{clear:left;float:left;margin:0 1rem 1rem}article .align-right{clear:right;float:right;margin:0 1rem 1rem}article .align-center,article .align-default{display:block;margin-left:auto;margin-right:auto;text-align:center}article table.align-default{display:table;text-align:initial}.domainindex-jumpbox,.genindex-jumpbox{border-bottom:1px solid var(--color-background-border);border-top:1px solid var(--color-background-border);padding:.25rem}.domainindex-section h2,.genindex-section h2{margin-bottom:.5rem;margin-top:.75rem}.domainindex-section ul,.genindex-section ul{margin-bottom:0;margin-top:0}ol,ul{margin-bottom:1rem;margin-top:1rem;padding-left:1.2rem}ol li>p:first-child,ul li>p:first-child{margin-bottom:.25rem;margin-top:.25rem}ol li>p:last-child,ul li>p:last-child{margin-top:.25rem}ol li>ol,ol li>ul,ul li>ol,ul li>ul{margin-bottom:.5rem;margin-top:.5rem}ol.arabic{list-style:decimal}ol.loweralpha{list-style:lower-alpha}ol.upperalpha{list-style:upper-alpha}ol.lowerroman{list-style:lower-roman}ol.upperroman{list-style:upper-roman}.simple li>ol,.simple li>ul,.toctree-wrapper li>ol,.toctree-wrapper li>ul{margin-bottom:0;margin-top:0}.field-list dt,.option-list dt,dl.footnote dt,dl.glossary dt,dl.simple dt,dl:not([class]) dt{font-weight:500;margin-top:.25rem}.field-list dt+dt,.option-list dt+dt,dl.footnote dt+dt,dl.glossary dt+dt,dl.simple dt+dt,dl:not([class]) dt+dt{margin-top:0}.field-list dt .classifier:before,.option-list dt .classifier:before,dl.footnote dt .classifier:before,dl.glossary dt .classifier:before,dl.simple dt .classifier:before,dl:not([class]) dt .classifier:before{content:":";margin-left:.2rem;margin-right:.2rem}.field-list dd ul,.field-list dd>p:first-child,.option-list dd ul,.option-list dd>p:first-child,dl.footnote dd ul,dl.footnote dd>p:first-child,dl.glossary dd ul,dl.glossary dd>p:first-child,dl.simple dd ul,dl.simple dd>p:first-child,dl:not([class]) dd ul,dl:not([class]) dd>p:first-child{margin-top:.125rem}.field-list dd ul,.option-list dd ul,dl.footnote dd ul,dl.glossary dd ul,dl.simple dd ul,dl:not([class]) dd ul{margin-bottom:.125rem}.math-wrapper{overflow-x:auto;width:100%}div.math{position:relative;text-align:center}div.math .headerlink,div.math:focus .headerlink{display:none}div.math:hover .headerlink{display:inline-block}div.math span.eqno{position:absolute;right:.5rem;top:50%;transform:translateY(-50%);z-index:1}abbr[title]{cursor:help}.problematic{color:var(--color-problematic)}kbd:not(.compound){background-color:var(--color-background-secondary);border:1px solid var(--color-foreground-border);border-radius:.2rem;box-shadow:0 .0625rem 0 rgba(0,0,0,.2),inset 0 0 0 .125rem var(--color-background-primary);color:var(--color-foreground-primary);display:inline-block;font-size:var(--font-size--small--3);margin:0 .2rem;padding:0 .2rem;vertical-align:text-bottom}blockquote{background:var(--color-background-secondary);border-left:4px solid var(--color-background-border);margin-left:0;margin-right:0;padding:.5rem 1rem}blockquote .attribution{font-weight:600;text-align:right}blockquote.highlights,blockquote.pull-quote{font-size:1.25em}blockquote.epigraph,blockquote.pull-quote{border-left-width:0;border-radius:.5rem}blockquote.highlights{background:transparent;border-left-width:0}p .reference img{vertical-align:middle}p.rubric{font-size:1.125em;font-weight:700;line-height:1.25}dd p.rubric{font-size:var(--font-size--small);font-weight:inherit;line-height:inherit;text-transform:uppercase}article .sidebar{background-color:var(--color-background-secondary);border:1px solid var(--color-background-border);border-radius:.2rem;clear:right;float:right;margin-left:1rem;margin-right:0;width:30%}article .sidebar>*{padding-left:1rem;padding-right:1rem}article .sidebar>ol,article .sidebar>ul{padding-left:2.2rem}article .sidebar .sidebar-title{border-bottom:1px solid var(--color-background-border);font-weight:500;margin:0;padding:.5rem 1rem}.table-wrapper{margin-bottom:.5rem;margin-top:1rem;overflow-x:auto;padding:.2rem .2rem .75rem;width:100%}table.docutils{border-collapse:collapse;border-radius:.2rem;border-spacing:0;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1)}table.docutils th{background:var(--color-table-header-background)}table.docutils td,table.docutils th{border-bottom:1px solid var(--color-table-border);border-left:1px solid var(--color-table-border);border-right:1px solid var(--color-table-border);padding:0 .25rem}table.docutils td p,table.docutils th p{margin:.25rem}table.docutils td:first-child,table.docutils th:first-child{border-left:none}table.docutils td:last-child,table.docutils th:last-child{border-right:none}table.docutils td.text-left,table.docutils th.text-left{text-align:left}table.docutils td.text-right,table.docutils th.text-right{text-align:right}table.docutils td.text-center,table.docutils th.text-center{text-align:center}:target{scroll-margin-top:.5rem}@media(max-width:67em){:target{scroll-margin-top:calc(.5rem + var(--header-height))}section>span:target{scroll-margin-top:calc(.8rem + var(--header-height))}}.headerlink{font-weight:100;-webkit-user-select:none;-moz-user-select:none;user-select:none}.code-block-caption>.headerlink,dl dt>.headerlink,figcaption p>.headerlink,h1>.headerlink,h2>.headerlink,h3>.headerlink,h4>.headerlink,h5>.headerlink,h6>.headerlink,p.caption>.headerlink,table>caption>.headerlink{margin-left:.5rem;visibility:hidden}.code-block-caption:hover>.headerlink,dl dt:hover>.headerlink,figcaption p:hover>.headerlink,h1:hover>.headerlink,h2:hover>.headerlink,h3:hover>.headerlink,h4:hover>.headerlink,h5:hover>.headerlink,h6:hover>.headerlink,p.caption:hover>.headerlink,table>caption:hover>.headerlink{visibility:visible}.code-block-caption>.toc-backref,dl dt>.toc-backref,figcaption p>.toc-backref,h1>.toc-backref,h2>.toc-backref,h3>.toc-backref,h4>.toc-backref,h5>.toc-backref,h6>.toc-backref,p.caption>.toc-backref,table>caption>.toc-backref{color:inherit;text-decoration-line:none}figure:hover>figcaption>p>.headerlink,table:hover>caption>.headerlink{visibility:visible}:target>h1:first-of-type,:target>h2:first-of-type,:target>h3:first-of-type,:target>h4:first-of-type,:target>h5:first-of-type,:target>h6:first-of-type,span:target~h1:first-of-type,span:target~h2:first-of-type,span:target~h3:first-of-type,span:target~h4:first-of-type,span:target~h5:first-of-type,span:target~h6:first-of-type{background-color:var(--color-highlight-on-target)}:target>h1:first-of-type code.literal,:target>h2:first-of-type code.literal,:target>h3:first-of-type code.literal,:target>h4:first-of-type code.literal,:target>h5:first-of-type code.literal,:target>h6:first-of-type code.literal,span:target~h1:first-of-type code.literal,span:target~h2:first-of-type code.literal,span:target~h3:first-of-type code.literal,span:target~h4:first-of-type code.literal,span:target~h5:first-of-type code.literal,span:target~h6:first-of-type code.literal{background-color:transparent}.literal-block-wrapper:target .code-block-caption,.this-will-duplicate-information-and-it-is-still-useful-here li :target,figure:target,table:target>caption{background-color:var(--color-highlight-on-target)}dt:target{background-color:var(--color-highlight-on-target)!important}.footnote-reference:target,.footnote>dt:target+dd{background-color:var(--color-highlight-on-target)}.guilabel{background-color:var(--color-guilabel-background);border:1px solid var(--color-guilabel-border);border-radius:.5em;color:var(--color-guilabel-text);font-size:.9em;padding:0 .3em}footer{display:flex;flex-direction:column;font-size:var(--font-size--small);margin-top:2rem}.bottom-of-page{align-items:center;border-top:1px solid var(--color-background-border);color:var(--color-foreground-secondary);display:flex;justify-content:space-between;line-height:1.5;margin-top:1rem;padding-bottom:1rem;padding-top:1rem}@media(max-width:46em){.bottom-of-page{flex-direction:column-reverse;gap:.25rem;text-align:center}}.bottom-of-page .left-details{font-size:var(--font-size--small)}.bottom-of-page .right-details{display:flex;flex-direction:column;gap:.25rem;text-align:right}.bottom-of-page .icons{display:flex;font-size:1rem;gap:.25rem;justify-content:flex-end}.bottom-of-page .icons a{text-decoration:none}.bottom-of-page .icons img,.bottom-of-page .icons svg{font-size:1.125rem;height:1em;width:1em}.related-pages a{align-items:center;display:flex;text-decoration:none}.related-pages a:hover .page-info .title{color:var(--color-link);text-decoration:underline;text-decoration-color:var(--color-link-underline)}.related-pages a svg.furo-related-icon,.related-pages a svg.furo-related-icon>use{color:var(--color-foreground-border);flex-shrink:0;height:.75rem;margin:0 .5rem;width:.75rem}.related-pages a.next-page{clear:right;float:right;max-width:50%;text-align:right}.related-pages a.prev-page{clear:left;float:left;max-width:50%}.related-pages a.prev-page svg{transform:rotate(180deg)}.page-info{display:flex;flex-direction:column;overflow-wrap:anywhere}.next-page .page-info{align-items:flex-end}.page-info .context{align-items:center;color:var(--color-foreground-muted);display:flex;font-size:var(--font-size--small);padding-bottom:.1rem;text-decoration:none}ul.search{list-style:none;padding-left:0}ul.search li{border-bottom:1px solid var(--color-background-border);padding:1rem 0}[role=main] .highlighted{background-color:var(--color-highlighted-background);color:var(--color-highlighted-text)}.sidebar-brand{display:flex;flex-direction:column;flex-shrink:0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-decoration:none}.sidebar-brand-text{color:var(--color-sidebar-brand-text);font-size:1.5rem;overflow-wrap:break-word}.sidebar-brand-text,.sidebar-logo-container{margin:var(--sidebar-item-spacing-vertical) 0}.sidebar-logo{display:block;margin:0 auto;max-width:100%}.sidebar-search-container{align-items:center;background:var(--color-sidebar-search-background);display:flex;margin-top:var(--sidebar-search-space-above);position:relative}.sidebar-search-container:focus-within,.sidebar-search-container:hover{background:var(--color-sidebar-search-background--focus)}.sidebar-search-container:before{background-color:var(--color-sidebar-search-icon);content:"";height:var(--sidebar-search-icon-size);left:var(--sidebar-item-spacing-horizontal);-webkit-mask-image:var(--icon-search);mask-image:var(--icon-search);position:absolute;width:var(--sidebar-search-icon-size)}.sidebar-search{background:transparent;border:none;border-bottom:1px solid var(--color-sidebar-search-border);border-top:1px solid var(--color-sidebar-search-border);box-sizing:border-box;color:var(--color-sidebar-search-foreground);padding:var(--sidebar-search-input-spacing-vertical) var(--sidebar-search-input-spacing-horizontal) var(--sidebar-search-input-spacing-vertical) calc(var(--sidebar-item-spacing-horizontal) + var(--sidebar-search-input-spacing-horizontal) + var(--sidebar-search-icon-size));width:100%;z-index:10}.sidebar-search:focus{outline:none}.sidebar-search::-moz-placeholder{font-size:var(--sidebar-search-input-font-size)}.sidebar-search::placeholder{font-size:var(--sidebar-search-input-font-size)}#searchbox .highlight-link{margin:0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal) 0;text-align:center}#searchbox .highlight-link a{color:var(--color-sidebar-search-icon);font-size:var(--font-size--small--2)}.sidebar-tree{font-size:var(--sidebar-item-font-size);margin-bottom:var(--sidebar-item-spacing-vertical);margin-top:var(--sidebar-tree-space-above)}.sidebar-tree ul{display:flex;flex-direction:column;list-style:none;margin-bottom:0;margin-top:0;padding:0}.sidebar-tree li{margin:0;position:relative}.sidebar-tree li>ul{margin-left:var(--sidebar-item-spacing-horizontal)}.sidebar-tree .icon,.sidebar-tree .reference{color:var(--color-sidebar-link-text)}.sidebar-tree .reference{box-sizing:border-box;display:inline-block;height:100%;line-height:var(--sidebar-item-line-height);overflow-wrap:anywhere;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-decoration:none;width:100%}.sidebar-tree .reference:hover{background:var(--color-sidebar-item-background--hover)}.sidebar-tree .reference.external:after{color:var(--color-sidebar-link-text);content:url("data:image/svg+xml;charset=utf-8,%3Csvg width='12' height='12' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' stroke-width='1.5' stroke='%23607D8B' fill='none' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M0 0h24v24H0z' stroke='none'/%3E%3Cpath d='M11 7H6a2 2 0 0 0-2 2v9a2 2 0 0 0 2 2h9a2 2 0 0 0 2-2v-5M10 14 20 4M15 4h5v5'/%3E%3C/svg%3E");margin:0 .25rem;vertical-align:middle}.sidebar-tree .current-page>.reference{font-weight:700}.sidebar-tree label{align-items:center;cursor:pointer;display:flex;height:var(--sidebar-item-height);justify-content:center;position:absolute;right:0;top:0;-webkit-user-select:none;-moz-user-select:none;user-select:none;width:var(--sidebar-expander-width)}.sidebar-tree .caption,.sidebar-tree :not(.caption)>.caption-text{color:var(--color-sidebar-caption-text);font-size:var(--sidebar-caption-font-size);font-weight:700;margin:var(--sidebar-caption-space-above) 0 0 0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-transform:uppercase}.sidebar-tree li.has-children>.reference{padding-right:var(--sidebar-expander-width)}.sidebar-tree .toctree-l1>.reference,.sidebar-tree .toctree-l1>label .icon{color:var(--color-sidebar-link-text--top-level)}.sidebar-tree label{background:var(--color-sidebar-item-expander-background)}.sidebar-tree label:hover{background:var(--color-sidebar-item-expander-background--hover)}.sidebar-tree .current>.reference{background:var(--color-sidebar-item-background--current)}.sidebar-tree .current>.reference:hover{background:var(--color-sidebar-item-background--hover)}.toctree-checkbox{display:none;position:absolute}.toctree-checkbox~ul{display:none}.toctree-checkbox~label .icon svg{transform:rotate(90deg)}.toctree-checkbox:checked~ul{display:block}.toctree-checkbox:checked~label .icon svg{transform:rotate(-90deg)}.toc-title-container{padding:var(--toc-title-padding);padding-top:var(--toc-spacing-vertical)}.toc-title{color:var(--color-toc-title-text);font-size:var(--toc-title-font-size);padding-left:var(--toc-spacing-horizontal);text-transform:uppercase}.no-toc{display:none}.toc-tree-container{padding-bottom:var(--toc-spacing-vertical)}.toc-tree{border-left:1px solid var(--color-background-border);font-size:var(--toc-font-size);line-height:1.3;padding-left:calc(var(--toc-spacing-horizontal) - var(--toc-item-spacing-horizontal))}.toc-tree>ul>li:first-child{padding-top:0}.toc-tree>ul>li:first-child>ul{padding-left:0}.toc-tree>ul>li:first-child>a{display:none}.toc-tree ul{list-style-type:none;margin-bottom:0;margin-top:0;padding-left:var(--toc-item-spacing-horizontal)}.toc-tree li{padding-top:var(--toc-item-spacing-vertical)}.toc-tree li.scroll-current>.reference{color:var(--color-toc-item-text--active);font-weight:700}.toc-tree .reference{color:var(--color-toc-item-text);overflow-wrap:anywhere;text-decoration:none}.toc-scroll{max-height:100vh;overflow-y:scroll}.contents:not(.this-will-duplicate-information-and-it-is-still-useful-here){background:rgba(255,0,0,.25);color:var(--color-problematic)}.contents:not(.this-will-duplicate-information-and-it-is-still-useful-here):before{content:"ERROR: Adding a table of contents in Furo-based documentation is unnecessary, and does not work well with existing styling.Add a 'this-will-duplicate-information-and-it-is-still-useful-here' class, if you want an escape hatch."}.text-align\:left>p{text-align:left}.text-align\:center>p{text-align:center}.text-align\:right>p{text-align:right} +/*# sourceMappingURL=furo.css.map*/ \ No newline at end of file diff --git a/_static/styles/furo.css.map b/_static/styles/furo.css.map new file mode 100644 index 0000000..d1dfb10 --- /dev/null +++ b/_static/styles/furo.css.map @@ -0,0 +1 @@ +{"version":3,"file":"styles/furo.css","mappings":"AAAA,2EAA2E,CAU3E,KAEE,6BAA8B,CAD9B,gBAEF,CASA,KACE,QACF,CAMA,KACE,aACF,CAOA,GACE,aAAc,CACd,cACF,CAUA,GACE,sBAAuB,CACvB,QAAS,CACT,gBACF,CAOA,IACE,+BAAiC,CACjC,aACF,CASA,EACE,4BACF,CAOA,YACE,kBAAmB,CACnB,yBAA0B,CAC1B,gCACF,CAMA,SAEE,kBACF,CAOA,cAGE,+BAAiC,CACjC,aACF,CAeA,QAEE,aAAc,CACd,aAAc,CACd,iBAAkB,CAClB,uBACF,CAEA,IACE,aACF,CAEA,IACE,SACF,CASA,IACE,iBACF,CAUA,sCAKE,mBAAoB,CACpB,cAAe,CACf,gBAAiB,CACjB,QACF,CAOA,aAEE,gBACF,CAOA,cAEE,mBACF,CAMA,gDAIE,yBACF,CAMA,wHAIE,iBAAkB,CAClB,SACF,CAMA,4GAIE,6BACF,CAMA,SACE,0BACF,CASA,OACE,qBAAsB,CACtB,aAAc,CACd,aAAc,CACd,cAAe,CACf,SAAU,CACV,kBACF,CAMA,SACE,uBACF,CAMA,SACE,aACF,CAOA,6BAEE,qBAAsB,CACtB,SACF,CAMA,kFAEE,WACF,CAOA,cACE,4BAA6B,CAC7B,mBACF,CAMA,yCACE,uBACF,CAOA,6BACE,yBAA0B,CAC1B,YACF,CASA,QACE,aACF,CAMA,QACE,iBACF,CAiBA,kBACE,YACF,CCvVA,aAcE,kEACE,uBAOF,WACE,iDAMF,gCACE,wBAEF,qCAEE,uBADA,uBACA,CAEF,SACE,wBAtBA,CCpBJ,iBAOE,6BAEA,mBANA,qBAEA,sBACA,0BAFA,oBAHA,4BAOA,6BANA,mBAOA,CAEF,gBACE,aCPF,KCGE,mHAEA,wGAGA,wBAAyB,CACzB,wBAAyB,CACzB,4BAA6B,CAC7B,yBAA0B,CAC1B,2BAA4B,CAG5B,sDAAuD,CACvD,gDAAiD,CACjD,wDAAyD,CAGzD,0CAA2C,CAC3C,gDAAiD,CACjD,gDAAiD,CAKjD,gCAAiC,CACjC,sCAAuC,CAGvC,2CAA4C,CAG5C,uCAAwC,CChCxC,+FAGA,uBAAwB,CAGxB,iCAAkC,CAClC,kCAAmC,CAEnC,+BAAgC,CAChC,sCAAuC,CACvC,sCAAuC,CACvC,qGAIA,mDAAoD,CAEpD,mCAAoC,CACpC,8CAA+C,CAC/C,gDAAiD,CACjD,kCAAmC,CACnC,6DAA8D,CAG9D,6BAA8B,CAC9B,6BAA8B,CAC9B,+BAAgC,CAChC,kCAAmC,CACnC,kCAAmC,CCPjC,ukBCYA,srCAZF,kaCVA,mLAOA,oTAWA,2UAaA,0CACA,gEACA,0CAGA,gEAUA,yCACA,+DAGA,4CACA,CACA,iEAGA,sGACA,uCACA,4DAGA,sCACA,2DAEA,4CACA,kEACA,oGACA,CAEA,0GACA,+CAGA,+MAOA,+EACA,wCAIA,4DACA,sEACA,kEACA,sEACA,gDAGA,+DACA,0CACA,gEACA,gGACA,CAGA,2DACA,qDAGA,0CACA,8CACA,oDACA,oDL7GF,iCAEA,iEAME,oCKyGA,yDAIA,sCACA,kCACA,sDAGA,0CACA,kEACA,oDAEA,sDAGA,oCACA,oEAIA,CAGA,yDAGA,qDACA,oDAGA,6DAIA,iEAGA,2DAEA,2DL9IE,4DAEA,gEAIF,gEKgGA,gFAIA,oNAOA,qDAEA,gFAIA,4DAIA,oEAMA,yEAIA,6DACA,0DAGA,uDAGA,qDAEA,wDLpII,6DAEA,yDACE,2DAMN,uCAIA,yCACE,8CAGF,sDMjDA,6DAKA,oCAIA,4CACA,kBAGF,sBAMA,2BAME,qCAGA,qCAEA,iCAEA,+BAEA,mCAEA,qCAIA,CACA,gCACA,gDAKA,kCAIA,6BAEA,0CAQA,kCAIF,8BAGE,8BACA,uCAGF,sCAKE,kCAEA,sDAGA,iCACE,CACA,2FAGA,gCACE,CACA,+DCzEJ,wCAEA,sBAEF,yDAEE,mCACA,wDAGA,2GAGA,wIACE,gDAMJ,kCAGE,6BACA,0CAGA,gEACA,8BACA,uCAKA,sCAIA,kCACA,sDACA,iCACA,sCAOA,sDAKE,gGAIE,+CAGN,sBAEE,yCAMA,0BAMA,yLAMA,aACA,MAEF,6BACE,2DAIF,wCAIE,kCAGA,SACA,kCAKA,mBAGA,CAJA,eACA,CAHF,gBAEE,CAWA,mBACA,mBACA,mDAGA,YACA,CACA,kBACA,CAEE,kBAKJ,OAPE,kBAQA,CADF,GACE,iCACA,wCAEA,wBACA,aACA,CAFA,WAEA,GACA,oBACA,CAFA,gBAEA,aACE,+CAIF,UAJE,kCAIF,WACA,iBACA,GAGA,uBACE,CAJF,yBAGA,CACE,iDACA,uCAEA,yDACE,cACA,wDAKN,yDAIE,uBAEF,kBACE,uBAEA,kDAIA,0DAGA,CAHA,oBAGA,0GAYA,aAEA,CAHA,YAGA,4HAKF,+CAGE,sBAEF,WAKE,0CAEA,CALA,qCAGA,CAJA,WAOA,SAIA,2CAJA,qCAIA,CACE,wBACA,OACA,YAEJ,gBACE,gBAIA,+CAKF,CAGE,kDAGA,CANF,8BAGE,CAGA,YAEA,CAdF,2BACE,CAHA,UAEF,CAYE,UAEA,CACA,0CACF,iEAOE,iCACA,8BAGA,wCAIA,wBAKE,0CAKF,CARE,6DAGA,CALF,qBAEE,CASA,YACA,yBAGA,CAEE,cAKN,CAPI,sBAOJ,gCAGE,qBAEA,WACA,aACA,sCAEA,mBACA,6BAGA,uEADA,qBACA,6BAIA,yBACA,qCAEE,UAEA,YACA,sBAEF,8BAGA,CAPE,aACA,WAMF,4BACE,sBACA,WAMJ,uBACE,cAYE,mBAXA,qDAKA,qCAGA,CAEA,YACA,CAHA,2BAEA,CACA,oCAEA,4CACA,uBAIA,oCAEJ,CAFI,cAIF,iBACE,CAHJ,kBAGI,yBAEA,oCAIA,qDAMF,mEAEA,CACE,8CAKA,gCAEA,qCAGA,oCAGE,sBACA,CAJF,WAEE,CAFF,eAEE,SAEA,mBACA,qCACE,aACA,CAFF,YADA,qBACA,WAEE,sBACA,kEAEN,2BAEE,iDAKA,uCAGF,CACE,0DAKA,kBACF,CAFE,sBAGA,mBACA,0BAEJ,yBAII,aADA,WACA,CAMF,UAFE,kBAEF,CAJF,gBACE,CAHE,iBAMF,6CC9ZF,yBACE,WACA,iBAEA,aAFA,iBAEA,6BAEA,kCACA,mBAKA,gCAGA,CARA,QAEA,CAGA,UALA,qBAEA,qDAGA,CALA,OAQA,4BACE,cAGF,2BACE,gCAEJ,CAHE,UAGF,8CAGE,CAHF,UAGE,wCAGA,qBACA,CAFA,UAEA,6CAGA,yCAIA,sBAHA,UAGA,kCACE,OACA,CAFF,KAEE,cAQF,0CACE,CAFF,kBACA,CACE,wEACA,CARA,YACA,CAKF,mBAFF,OAII,eACA,CAJF,iCAJE,cAGJ,CANI,oBAEA,CAKF,SAIE,2BADA,UACA,kBAGF,sCACA,CAFF,WACE,WACA,qCACE,gCACA,2EACA,sDAKJ,aACE,mDAII,CAJJ,6CAII,kEACA,iBACE,iDACA,+CACE,aACA,WADA,+BACA,uEANN,YACE,mDAEE,mBADF,0CACE,CADF,qBACE,0DACA,YACE,4DACA,sEANN,YACE,8CACA,kBADA,UACA,2CACE,2EACA,cACE,kEACA,mEANN,yBACE,4DACA,sBACE,+EAEE,iEACA,qEANN,sCACE,CAGE,iBAHF,gBAGE,qBACE,CAJJ,uBACA,gDACE,wDACA,6DAHF,2CACA,CADA,gBACA,eACE,CAGE,sBANN,8BACE,CAII,iBAFF,4DACA,WACE,YADF,uCACE,6EACA,2BANN,8CACE,kDACA,0CACE,8BACA,yFACE,sBACA,sFALJ,mEACA,sBACE,kEACA,6EACE,uCACA,kEALJ,qGAEE,kEACA,6EACE,uCACA,kEALJ,8CACA,uDACE,sEACA,2EACE,sCACA,iEALJ,mGACA,qCACE,oDACA,0DACE,6GACA,gDAGR,yDCrEA,sEACE,CACA,6GACE,gEACF,iGAIF,wFACE,qDAGA,mGAEE,2CAEF,4FACE,gCACF,wGACE,8DAEE,6FAIA,iJAKN,6GACE,gDAKF,yDACA,qCAGA,6BACA,kBACA,qDAKA,oCAEA,+DAGA,2CAGE,oDAIA,oEAEE,qBAGJ,wDAEE,uCAEF,kEAGA,8CAEA,uDAKA,oCAEA,yDAEE,gEAKF,+CC5FA,0EAGE,CACA,qDCLJ,+DAIE,sCAIA,kEACE,yBACA,2FAMA,gBACA,yGCbF,mBAOA,2MAIA,4HAYA,0DACE,8GAYF,8HAQE,mBAEA,6HAOF,YAGA,mIAME,eACA,CAFF,YAEE,4FAMJ,8BAEE,uBAYA,sCAEE,CAJF,oBAEA,CARA,wCAEA,CAHA,8BACA,CAFA,eACA,CAGA,wCAEA,CAEA,mDAIE,kCACE,6BACA,4CAKJ,kDAIA,eACE,aAGF,8BACE,uDACA,sCACA,cAEA,+BACA,CAFA,eAEA,wCAEF,YACE,iBACA,mCACA,0DAGF,qBAEE,CAFF,kBAEE,+BAIA,yCAEE,qBADA,gBACA,yBAKF,eACA,CAFF,YACE,CACA,iBACA,qDAEA,mDCvIJ,2FAOE,iCACA,CAEA,eACA,CAHA,kBAEA,CAFA,wBAGA,8BACA,eACE,CAFF,YAEE,0BACA,8CAGA,oBACE,oCAGA,kBACE,8DAEA,iBAEN,UACE,8BAIJ,+CAEE,qDAEF,kDAIE,YAEF,CAFE,YAEF,CCjCE,mFAJA,QACA,UAIE,CADF,iBACE,mCAGA,iDACE,+BAGF,wBAEA,mBAKA,6CAEF,CAHE,mBACA,CAEF,kCAIE,CARA,kBACA,CAFF,eASE,YACA,mBAGF,CAJE,UAIF,wCCjCA,oBDmCE,wBCpCJ,uCACE,8BACA,4CACA,oBAGA,2CCAA,6CAGE,CAPF,uBAIA,CDGA,gDACE,6BCVJ,CAWM,2CAEF,CAJA,kCAEE,CDJF,aCLF,gBDKE,uBCMA,gCAGA,gDAGE,wBAGJ,0BAEA,iBACE,aACF,CADE,UACF,uBACE,aACF,oBACE,YACF,4BACE,6CAMA,CAYF,6DAZE,mCAGE,iCASJ,4BAGE,4DADA,+BACA,CAFA,qBAEA,yBACE,aAEF,wBAHA,SAGA,iHACE,2DAKF,CANA,yCACE,CADF,oCAMA,uSAIA,sGACE,oDChEJ,WAEF,yBACE,QACA,eAEA,gBAEE,uCAGA,CALF,iCAKE,uCAGA,0BACA,CACA,oBACA,iCClBJ,gBACE,KAGF,qBACE,YAGF,CAHE,cAGF,gCAEE,mBACA,iEAEA,oCACA,wCAEA,sBACA,WAEA,CAFA,YAEA,8EAEA,mCAFA,iBAEA,6BAIA,wEAKA,sDAIE,CARF,mDAIA,CAIE,cAEF,8CAIA,oBAFE,iBAEF,8CAGE,eAEF,CAFE,YAEF,OAEE,kBAGJ,CAJI,eACA,CAFF,mBAKF,yCCjDE,oBACA,CAFA,iBAEA,uCAKE,iBACA,qCAGA,mBCZJ,CDWI,gBCXJ,6BAEE,eACA,sBAGA,eAEA,sBACA,oDACA,iGAMA,gBAFE,YAEF,8FAME,iJClBF,YACA,gNAUE,6BAEF,oTAcI,kBACF,gHAIA,qBACE,eACF,qDACE,kBACF,6DACE,4BCxCJ,oBAEF,qCAEI,+CAGF,uBACE,uDAGJ,oBAkBE,mDAhBA,+CAaA,CAbA,oBAaA,0FAEE,CAFF,gGAbA,+BAaA,0BAGA,mQAIA,oNAEE,iBAGJ,CAHI,gBADA,gBAIJ,8CAYI,CAZJ,wCAYI,sVACE,iCAGA,uEAHA,QAGA,qXAKJ,iDAGF,CARM,+CACE,iDAIN,CALI,gBAQN,mHACE,gBAGF,2DACE,0EAOA,0EAKA,6EC/EA,iDACA,gCACA,oDAGA,qBACA,oDCFA,cACA,eAEA,yBAGF,sBAEE,iBACA,sNAWA,iBACE,kBACA,wRAgBA,kBAEA,iOAgBA,uCACE,uEAEA,kBAEF,qUAuBE,iDAIJ,CACA,geCxFF,4BAEE,CAQA,6JACA,iDAIA,sEAGA,mDAOF,iDAGE,4DAIA,8CACA,qDAEE,eAFF,cAEE,oBAEF,uBAFE,kCAGA,eACA,iBACA,mBAIA,mDACA,CAHA,uCAEA,CAJA,0CACA,CAIA,gBAJA,gBACA,oBADA,gBAIA,wBAEJ,gBAGE,6BACA,YAHA,iBAGA,gCACA,iEAEA,6CACA,sDACA,0BADA,wBACA,0BACA,oIAIA,mBAFA,YAEA,qBACA,0CAIE,uBAEF,CAHA,yBACE,CAEF,iDACE,mFAKJ,oCACE,CANE,aAKJ,CACE,qEAIA,YAFA,WAEA,CAHA,aACA,CAEA,gBACE,4BACA,sBADA,aACA,gCAMF,oCACA,yDACA,2CAEA,qBAGE,kBAEA,CACA,mCAIF,CARE,YACA,CAOF,iCAEE,CAPA,oBACA,CAQA,oBACE,uDAEJ,sDAGA,CAHA,cAGA,0BACE,oDAIA,oCACA,4BACA,sBAGA,cAEA,oFAGA,sBAEA,yDACE,CAIA,iBAJA,wBAIA,6CAJA,6CAOA,4BAGJ,CAHI,cAGJ,yCAGA,kBACE,CAIA,iDAEA,CATA,YAEF,CACE,4CAGA,kBAIA,wEAEA,wDAIF,kCAOE,iDACA,CARF,WAIE,sCAGA,CANA,2CACA,CAMA,oEARF,iBACE,CACA,qCAMA,iBAuBE,uBAlBF,YAKA,2DALA,uDAKA,CALA,sBAiBA,4CACE,CALA,gRAIF,YACE,UAEN,uBACE,YACA,mCAOE,+CAGA,8BAGF,+CAGA,4BCjNA,SDiNA,qFCjNA,gDAGA,sCACA,qCACA,sDAIF,CAIE,kDAGA,CAPF,0CAOE,kBAEA,kDAEA,CAHA,eACA,CAFA,YACA,CADA,SAIA,mHAIE,CAGA,6CAFA,oCAeE,CAbF,yBACE,qBAEJ,CAGE,oBACA,CAEA,YAFA,2CACF,CACE,uBAEA,mFAEE,CALJ,oBACE,CAEA,UAEE,gCAGF,sDAEA,yCC7CJ,oCAGA,CD6CE,yXAQE,sCCrDJ,wCAGA,oCACE","sources":["webpack:///./node_modules/normalize.css/normalize.css","webpack:///./src/furo/assets/styles/base/_print.sass","webpack:///./src/furo/assets/styles/base/_screen-readers.sass","webpack:///./src/furo/assets/styles/base/_theme.sass","webpack:///./src/furo/assets/styles/variables/_fonts.scss","webpack:///./src/furo/assets/styles/variables/_spacing.scss","webpack:///./src/furo/assets/styles/variables/_icons.scss","webpack:///./src/furo/assets/styles/variables/_admonitions.scss","webpack:///./src/furo/assets/styles/variables/_colors.scss","webpack:///./src/furo/assets/styles/base/_typography.sass","webpack:///./src/furo/assets/styles/_scaffold.sass","webpack:///./src/furo/assets/styles/content/_admonitions.sass","webpack:///./src/furo/assets/styles/content/_api.sass","webpack:///./src/furo/assets/styles/content/_blocks.sass","webpack:///./src/furo/assets/styles/content/_captions.sass","webpack:///./src/furo/assets/styles/content/_code.sass","webpack:///./src/furo/assets/styles/content/_footnotes.sass","webpack:///./src/furo/assets/styles/content/_images.sass","webpack:///./src/furo/assets/styles/content/_indexes.sass","webpack:///./src/furo/assets/styles/content/_lists.sass","webpack:///./src/furo/assets/styles/content/_math.sass","webpack:///./src/furo/assets/styles/content/_misc.sass","webpack:///./src/furo/assets/styles/content/_rubrics.sass","webpack:///./src/furo/assets/styles/content/_sidebar.sass","webpack:///./src/furo/assets/styles/content/_tables.sass","webpack:///./src/furo/assets/styles/content/_target.sass","webpack:///./src/furo/assets/styles/content/_gui-labels.sass","webpack:///./src/furo/assets/styles/components/_footer.sass","webpack:///./src/furo/assets/styles/components/_sidebar.sass","webpack:///./src/furo/assets/styles/components/_table_of_contents.sass","webpack:///./src/furo/assets/styles/_shame.sass"],"sourcesContent":["/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */\n\n/* Document\n ========================================================================== */\n\n/**\n * 1. Correct the line height in all browsers.\n * 2. Prevent adjustments of font size after orientation changes in iOS.\n */\n\nhtml {\n line-height: 1.15; /* 1 */\n -webkit-text-size-adjust: 100%; /* 2 */\n}\n\n/* Sections\n ========================================================================== */\n\n/**\n * Remove the margin in all browsers.\n */\n\nbody {\n margin: 0;\n}\n\n/**\n * Render the `main` element consistently in IE.\n */\n\nmain {\n display: block;\n}\n\n/**\n * Correct the font size and margin on `h1` elements within `section` and\n * `article` contexts in Chrome, Firefox, and Safari.\n */\n\nh1 {\n font-size: 2em;\n margin: 0.67em 0;\n}\n\n/* Grouping content\n ========================================================================== */\n\n/**\n * 1. Add the correct box sizing in Firefox.\n * 2. Show the overflow in Edge and IE.\n */\n\nhr {\n box-sizing: content-box; /* 1 */\n height: 0; /* 1 */\n overflow: visible; /* 2 */\n}\n\n/**\n * 1. Correct the inheritance and scaling of font size in all browsers.\n * 2. Correct the odd `em` font sizing in all browsers.\n */\n\npre {\n font-family: monospace, monospace; /* 1 */\n font-size: 1em; /* 2 */\n}\n\n/* Text-level semantics\n ========================================================================== */\n\n/**\n * Remove the gray background on active links in IE 10.\n */\n\na {\n background-color: transparent;\n}\n\n/**\n * 1. Remove the bottom border in Chrome 57-\n * 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.\n */\n\nabbr[title] {\n border-bottom: none; /* 1 */\n text-decoration: underline; /* 2 */\n text-decoration: underline dotted; /* 2 */\n}\n\n/**\n * Add the correct font weight in Chrome, Edge, and Safari.\n */\n\nb,\nstrong {\n font-weight: bolder;\n}\n\n/**\n * 1. Correct the inheritance and scaling of font size in all browsers.\n * 2. Correct the odd `em` font sizing in all browsers.\n */\n\ncode,\nkbd,\nsamp {\n font-family: monospace, monospace; /* 1 */\n font-size: 1em; /* 2 */\n}\n\n/**\n * Add the correct font size in all browsers.\n */\n\nsmall {\n font-size: 80%;\n}\n\n/**\n * Prevent `sub` and `sup` elements from affecting the line height in\n * all browsers.\n */\n\nsub,\nsup {\n font-size: 75%;\n line-height: 0;\n position: relative;\n vertical-align: baseline;\n}\n\nsub {\n bottom: -0.25em;\n}\n\nsup {\n top: -0.5em;\n}\n\n/* Embedded content\n ========================================================================== */\n\n/**\n * Remove the border on images inside links in IE 10.\n */\n\nimg {\n border-style: none;\n}\n\n/* Forms\n ========================================================================== */\n\n/**\n * 1. Change the font styles in all browsers.\n * 2. Remove the margin in Firefox and Safari.\n */\n\nbutton,\ninput,\noptgroup,\nselect,\ntextarea {\n font-family: inherit; /* 1 */\n font-size: 100%; /* 1 */\n line-height: 1.15; /* 1 */\n margin: 0; /* 2 */\n}\n\n/**\n * Show the overflow in IE.\n * 1. Show the overflow in Edge.\n */\n\nbutton,\ninput { /* 1 */\n overflow: visible;\n}\n\n/**\n * Remove the inheritance of text transform in Edge, Firefox, and IE.\n * 1. Remove the inheritance of text transform in Firefox.\n */\n\nbutton,\nselect { /* 1 */\n text-transform: none;\n}\n\n/**\n * Correct the inability to style clickable types in iOS and Safari.\n */\n\nbutton,\n[type=\"button\"],\n[type=\"reset\"],\n[type=\"submit\"] {\n -webkit-appearance: button;\n}\n\n/**\n * Remove the inner border and padding in Firefox.\n */\n\nbutton::-moz-focus-inner,\n[type=\"button\"]::-moz-focus-inner,\n[type=\"reset\"]::-moz-focus-inner,\n[type=\"submit\"]::-moz-focus-inner {\n border-style: none;\n padding: 0;\n}\n\n/**\n * Restore the focus styles unset by the previous rule.\n */\n\nbutton:-moz-focusring,\n[type=\"button\"]:-moz-focusring,\n[type=\"reset\"]:-moz-focusring,\n[type=\"submit\"]:-moz-focusring {\n outline: 1px dotted ButtonText;\n}\n\n/**\n * Correct the padding in Firefox.\n */\n\nfieldset {\n padding: 0.35em 0.75em 0.625em;\n}\n\n/**\n * 1. Correct the text wrapping in Edge and IE.\n * 2. Correct the color inheritance from `fieldset` elements in IE.\n * 3. Remove the padding so developers are not caught out when they zero out\n * `fieldset` elements in all browsers.\n */\n\nlegend {\n box-sizing: border-box; /* 1 */\n color: inherit; /* 2 */\n display: table; /* 1 */\n max-width: 100%; /* 1 */\n padding: 0; /* 3 */\n white-space: normal; /* 1 */\n}\n\n/**\n * Add the correct vertical alignment in Chrome, Firefox, and Opera.\n */\n\nprogress {\n vertical-align: baseline;\n}\n\n/**\n * Remove the default vertical scrollbar in IE 10+.\n */\n\ntextarea {\n overflow: auto;\n}\n\n/**\n * 1. Add the correct box sizing in IE 10.\n * 2. Remove the padding in IE 10.\n */\n\n[type=\"checkbox\"],\n[type=\"radio\"] {\n box-sizing: border-box; /* 1 */\n padding: 0; /* 2 */\n}\n\n/**\n * Correct the cursor style of increment and decrement buttons in Chrome.\n */\n\n[type=\"number\"]::-webkit-inner-spin-button,\n[type=\"number\"]::-webkit-outer-spin-button {\n height: auto;\n}\n\n/**\n * 1. Correct the odd appearance in Chrome and Safari.\n * 2. Correct the outline style in Safari.\n */\n\n[type=\"search\"] {\n -webkit-appearance: textfield; /* 1 */\n outline-offset: -2px; /* 2 */\n}\n\n/**\n * Remove the inner padding in Chrome and Safari on macOS.\n */\n\n[type=\"search\"]::-webkit-search-decoration {\n -webkit-appearance: none;\n}\n\n/**\n * 1. Correct the inability to style clickable types in iOS and Safari.\n * 2. Change font properties to `inherit` in Safari.\n */\n\n::-webkit-file-upload-button {\n -webkit-appearance: button; /* 1 */\n font: inherit; /* 2 */\n}\n\n/* Interactive\n ========================================================================== */\n\n/*\n * Add the correct display in Edge, IE 10+, and Firefox.\n */\n\ndetails {\n display: block;\n}\n\n/*\n * Add the correct display in all browsers.\n */\n\nsummary {\n display: list-item;\n}\n\n/* Misc\n ========================================================================== */\n\n/**\n * Add the correct display in IE 10+.\n */\n\ntemplate {\n display: none;\n}\n\n/**\n * Add the correct display in IE 10.\n */\n\n[hidden] {\n display: none;\n}\n","// This file contains styles for managing print media.\n\n////////////////////////////////////////////////////////////////////////////////\n// Hide elements not relevant to print media.\n////////////////////////////////////////////////////////////////////////////////\n@media print\n // Hide icon container.\n .content-icon-container\n display: none !important\n\n // Hide showing header links if hovering over when printing.\n .headerlink\n display: none !important\n\n // Hide mobile header.\n .mobile-header\n display: none !important\n\n // Hide navigation links.\n .related-pages\n display: none !important\n\n////////////////////////////////////////////////////////////////////////////////\n// Tweaks related to decolorization.\n////////////////////////////////////////////////////////////////////////////////\n@media print\n // Apply a border around code which no longer have a color background.\n .highlight\n border: 0.1pt solid var(--color-foreground-border)\n\n////////////////////////////////////////////////////////////////////////////////\n// Avoid page break in some relevant cases.\n////////////////////////////////////////////////////////////////////////////////\n@media print\n ul, ol, dl, a, table, pre, blockquote\n page-break-inside: avoid\n\n h1, h2, h3, h4, h5, h6, img, figure, caption\n page-break-inside: avoid\n page-break-after: avoid\n\n ul, ol, dl\n page-break-before: avoid\n",".visually-hidden\n position: absolute !important\n width: 1px !important\n height: 1px !important\n padding: 0 !important\n margin: -1px !important\n overflow: hidden !important\n clip: rect(0,0,0,0) !important\n white-space: nowrap !important\n border: 0 !important\n\n:-moz-focusring\n outline: auto\n","// This file serves as the \"skeleton\" of the theming logic.\n//\n// This contains the bulk of the logic for handling dark mode, color scheme\n// toggling and the handling of color-scheme-specific hiding of elements.\n\nbody\n @include fonts\n @include spacing\n @include icons\n @include admonitions\n @include default-admonition(#651fff, \"abstract\")\n @include default-topic(#14B8A6, \"pencil\")\n\n @include colors\n\n.only-light\n display: block !important\nhtml body .only-dark\n display: none !important\n\n// Ignore dark-mode hints if print media.\n@media not print\n // Enable dark-mode, if requested.\n body[data-theme=\"dark\"]\n @include colors-dark\n\n html & .only-light\n display: none !important\n .only-dark\n display: block !important\n\n // Enable dark mode, unless explicitly told to avoid.\n @media (prefers-color-scheme: dark)\n body:not([data-theme=\"light\"])\n @include colors-dark\n\n html & .only-light\n display: none !important\n .only-dark\n display: block !important\n\n//\n// Theme toggle presentation\n//\nbody[data-theme=\"auto\"]\n .theme-toggle svg.theme-icon-when-auto\n display: block\n\nbody[data-theme=\"dark\"]\n .theme-toggle svg.theme-icon-when-dark\n display: block\n\nbody[data-theme=\"light\"]\n .theme-toggle svg.theme-icon-when-light\n display: block\n","// Fonts used by this theme.\n//\n// There are basically two things here -- using the system font stack and\n// defining sizes for various elements in %ages. We could have also used `em`\n// but %age is easier to reason about for me.\n\n@mixin fonts {\n // These are adapted from https://systemfontstack.com/\n --font-stack: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial,\n sans-serif, Apple Color Emoji, Segoe UI Emoji;\n --font-stack--monospace: \"SFMono-Regular\", Menlo, Consolas, Monaco,\n Liberation Mono, Lucida Console, monospace;\n\n --font-size--normal: 100%;\n --font-size--small: 87.5%;\n --font-size--small--2: 81.25%;\n --font-size--small--3: 75%;\n --font-size--small--4: 62.5%;\n\n // Sidebar\n --sidebar-caption-font-size: var(--font-size--small--2);\n --sidebar-item-font-size: var(--font-size--small);\n --sidebar-search-input-font-size: var(--font-size--small);\n\n // Table of Contents\n --toc-font-size: var(--font-size--small--3);\n --toc-font-size--mobile: var(--font-size--normal);\n --toc-title-font-size: var(--font-size--small--4);\n\n // Admonitions\n //\n // These aren't defined in terms of %ages, since nesting these is permitted.\n --admonition-font-size: 0.8125rem;\n --admonition-title-font-size: 0.8125rem;\n\n // Code\n --code-font-size: var(--font-size--small--2);\n\n // API\n --api-font-size: var(--font-size--small);\n}\n","// Spacing for various elements on the page\n//\n// If the user wants to tweak things in a certain way, they are permitted to.\n// They also have to deal with the consequences though!\n\n@mixin spacing {\n // Header!\n --header-height: calc(\n var(--sidebar-item-line-height) + 4 * #{var(--sidebar-item-spacing-vertical)}\n );\n --header-padding: 0.5rem;\n\n // Sidebar\n --sidebar-tree-space-above: 1.5rem;\n --sidebar-caption-space-above: 1rem;\n\n --sidebar-item-line-height: 1rem;\n --sidebar-item-spacing-vertical: 0.5rem;\n --sidebar-item-spacing-horizontal: 1rem;\n --sidebar-item-height: calc(\n var(--sidebar-item-line-height) + 2 *#{var(--sidebar-item-spacing-vertical)}\n );\n\n --sidebar-expander-width: var(--sidebar-item-height); // be square\n\n --sidebar-search-space-above: 0.5rem;\n --sidebar-search-input-spacing-vertical: 0.5rem;\n --sidebar-search-input-spacing-horizontal: 0.5rem;\n --sidebar-search-input-height: 1rem;\n --sidebar-search-icon-size: var(--sidebar-search-input-height);\n\n // Table of Contents\n --toc-title-padding: 0.25rem 0;\n --toc-spacing-vertical: 1.5rem;\n --toc-spacing-horizontal: 1.5rem;\n --toc-item-spacing-vertical: 0.4rem;\n --toc-item-spacing-horizontal: 1rem;\n}\n","// Expose theme icons as CSS variables.\n\n$icons: (\n // Adapted from tabler-icons\n // url: https://tablericons.com/\n \"search\":\n url('data:image/svg+xml;charset=utf-8,'),\n // Factored out from mkdocs-material on 24-Aug-2020.\n // url: https://squidfunk.github.io/mkdocs-material/reference/admonitions/\n \"pencil\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"abstract\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"info\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"flame\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"question\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"warning\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"failure\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"spark\":\n url('data:image/svg+xml;charset=utf-8,')\n);\n\n@mixin icons {\n @each $name, $glyph in $icons {\n --icon-#{$name}: #{$glyph};\n }\n}\n","// Admonitions\n\n// Structure of these is:\n// admonition-class: color \"icon-name\";\n//\n// The colors are translated into CSS variables below. The icons are\n// used directly in the main declarations to set the `mask-image` in\n// the title.\n\n// prettier-ignore\n$admonitions: (\n // Each of these has an reST directives for it.\n \"caution\": #ff9100 \"spark\",\n \"warning\": #ff9100 \"warning\",\n \"danger\": #ff5252 \"spark\",\n \"attention\": #ff5252 \"warning\",\n \"error\": #ff5252 \"failure\",\n \"hint\": #00c852 \"question\",\n \"tip\": #00c852 \"info\",\n \"important\": #00bfa5 \"flame\",\n \"note\": #00b0ff \"pencil\",\n \"seealso\": #448aff \"info\",\n \"admonition-todo\": #808080 \"pencil\"\n);\n\n@mixin default-admonition($color, $icon-name) {\n --color-admonition-title: #{$color};\n --color-admonition-title-background: #{rgba($color, 0.2)};\n\n --icon-admonition-default: var(--icon-#{$icon-name});\n}\n\n@mixin default-topic($color, $icon-name) {\n --color-topic-title: #{$color};\n --color-topic-title-background: #{rgba($color, 0.2)};\n\n --icon-topic-default: var(--icon-#{$icon-name});\n}\n\n@mixin admonitions {\n @each $name, $values in $admonitions {\n --color-admonition-title--#{$name}: #{nth($values, 1)};\n --color-admonition-title-background--#{$name}: #{rgba(\n nth($values, 1),\n 0.2\n )};\n }\n}\n","// Colors used throughout this theme.\n//\n// The aim is to give the user more control. Thus, instead of hard-coding colors\n// in various parts of the stylesheet, the approach taken is to define all\n// colors as CSS variables and reusing them in all the places.\n//\n// `colors-dark` depends on `colors` being included at a lower specificity.\n\n@mixin colors {\n --color-problematic: #b30000;\n\n // Base Colors\n --color-foreground-primary: black; // for main text and headings\n --color-foreground-secondary: #5a5c63; // for secondary text\n --color-foreground-muted: #646776; // for muted text\n --color-foreground-border: #878787; // for content borders\n\n --color-background-primary: white; // for content\n --color-background-secondary: #f8f9fb; // for navigation + ToC\n --color-background-hover: #efeff4ff; // for navigation-item hover\n --color-background-hover--transparent: #efeff400;\n --color-background-border: #eeebee; // for UI borders\n --color-background-item: #ccc; // for \"background\" items (eg: copybutton)\n\n // Announcements\n --color-announcement-background: #000000dd;\n --color-announcement-text: #eeebee;\n\n // Brand colors\n --color-brand-primary: #2962ff;\n --color-brand-content: #2a5adf;\n\n // API documentation\n --color-api-background: var(--color-background-hover--transparent);\n --color-api-background-hover: var(--color-background-hover);\n --color-api-overall: var(--color-foreground-secondary);\n --color-api-name: var(--color-problematic);\n --color-api-pre-name: var(--color-problematic);\n --color-api-paren: var(--color-foreground-secondary);\n --color-api-keyword: var(--color-foreground-primary);\n --color-highlight-on-target: #ffffcc;\n\n // Inline code background\n --color-inline-code-background: var(--color-background-secondary);\n\n // Highlighted text (search)\n --color-highlighted-background: #ddeeff;\n --color-highlighted-text: var(--color-foreground-primary);\n\n // GUI Labels\n --color-guilabel-background: #ddeeff80;\n --color-guilabel-border: #bedaf580;\n --color-guilabel-text: var(--color-foreground-primary);\n\n // Admonitions!\n --color-admonition-background: transparent;\n\n //////////////////////////////////////////////////////////////////////////////\n // Everything below this should be one of:\n // - var(...)\n // - *-gradient(...)\n // - special literal values (eg: transparent, none)\n //////////////////////////////////////////////////////////////////////////////\n\n // Tables\n --color-table-header-background: var(--color-background-secondary);\n --color-table-border: var(--color-background-border);\n\n // Cards\n --color-card-border: var(--color-background-secondary);\n --color-card-background: transparent;\n --color-card-marginals-background: var(--color-background-secondary);\n\n // Header\n --color-header-background: var(--color-background-primary);\n --color-header-border: var(--color-background-border);\n --color-header-text: var(--color-foreground-primary);\n\n // Sidebar (left)\n --color-sidebar-background: var(--color-background-secondary);\n --color-sidebar-background-border: var(--color-background-border);\n\n --color-sidebar-brand-text: var(--color-foreground-primary);\n --color-sidebar-caption-text: var(--color-foreground-muted);\n --color-sidebar-link-text: var(--color-foreground-secondary);\n --color-sidebar-link-text--top-level: var(--color-brand-primary);\n\n --color-sidebar-item-background: var(--color-sidebar-background);\n --color-sidebar-item-background--current: var(\n --color-sidebar-item-background\n );\n --color-sidebar-item-background--hover: linear-gradient(\n 90deg,\n var(--color-background-hover--transparent) 0%,\n var(--color-background-hover) var(--sidebar-item-spacing-horizontal),\n var(--color-background-hover) 100%\n );\n\n --color-sidebar-item-expander-background: transparent;\n --color-sidebar-item-expander-background--hover: var(\n --color-background-hover\n );\n\n --color-sidebar-search-text: var(--color-foreground-primary);\n --color-sidebar-search-background: var(--color-background-secondary);\n --color-sidebar-search-background--focus: var(--color-background-primary);\n --color-sidebar-search-border: var(--color-background-border);\n --color-sidebar-search-icon: var(--color-foreground-muted);\n\n // Table of Contents (right)\n --color-toc-background: var(--color-background-primary);\n --color-toc-title-text: var(--color-foreground-muted);\n --color-toc-item-text: var(--color-foreground-secondary);\n --color-toc-item-text--hover: var(--color-foreground-primary);\n --color-toc-item-text--active: var(--color-brand-primary);\n\n // Actual page contents\n --color-content-foreground: var(--color-foreground-primary);\n --color-content-background: transparent;\n\n // Links\n --color-link: var(--color-brand-content);\n --color-link--hover: var(--color-brand-content);\n --color-link-underline: var(--color-background-border);\n --color-link-underline--hover: var(--color-foreground-border);\n}\n\n@mixin colors-dark {\n --color-problematic: #ee5151;\n\n // Base Colors\n --color-foreground-primary: #ffffffcc; // for main text and headings\n --color-foreground-secondary: #9ca0a5; // for secondary text\n --color-foreground-muted: #81868d; // for muted text\n --color-foreground-border: #666666; // for content borders\n\n --color-background-primary: #131416; // for content\n --color-background-secondary: #1a1c1e; // for navigation + ToC\n --color-background-hover: #1e2124ff; // for navigation-item hover\n --color-background-hover--transparent: #1e212400;\n --color-background-border: #303335; // for UI borders\n --color-background-item: #444; // for \"background\" items (eg: copybutton)\n\n // Announcements\n --color-announcement-background: #000000dd;\n --color-announcement-text: #eeebee;\n\n // Brand colors\n --color-brand-primary: #2b8cee;\n --color-brand-content: #368ce2;\n\n // Highlighted text (search)\n --color-highlighted-background: #083563;\n\n // GUI Labels\n --color-guilabel-background: #08356380;\n --color-guilabel-border: #13395f80;\n\n // API documentation\n --color-api-keyword: var(--color-foreground-secondary);\n --color-highlight-on-target: #333300;\n\n // Admonitions\n --color-admonition-background: #18181a;\n\n // Cards\n --color-card-border: var(--color-background-secondary);\n --color-card-background: #18181a;\n --color-card-marginals-background: var(--color-background-hover);\n}\n","// This file contains the styling for making the content throughout the page,\n// including fonts, paragraphs, headings and spacing among these elements.\n\nbody\n font-family: var(--font-stack)\npre,\ncode,\nkbd,\nsamp\n font-family: var(--font-stack--monospace)\n\n// Make fonts look slightly nicer.\nbody\n -webkit-font-smoothing: antialiased\n -moz-osx-font-smoothing: grayscale\n\n// Line height from Bootstrap 4.1\narticle\n line-height: 1.5\n\n//\n// Headings\n//\nh1,\nh2,\nh3,\nh4,\nh5,\nh6\n line-height: 1.25\n font-weight: bold\n\n border-radius: 0.5rem\n margin-top: 0.5rem\n margin-bottom: 0.5rem\n margin-left: -0.5rem\n margin-right: -0.5rem\n padding-left: 0.5rem\n padding-right: 0.5rem\n\n + p\n margin-top: 0\n\nh1\n font-size: 2.5em\n margin-top: 1.75rem\n margin-bottom: 1rem\nh2\n font-size: 2em\n margin-top: 1.75rem\nh3\n font-size: 1.5em\nh4\n font-size: 1.25em\nh5\n font-size: 1.125em\nh6\n font-size: 1em\n\nsmall\n opacity: 75%\n font-size: 80%\n\n// Paragraph\np\n margin-top: 0.5rem\n margin-bottom: 0.75rem\n\n// Horizontal rules\nhr.docutils\n height: 1px\n padding: 0\n margin: 2rem 0\n background-color: var(--color-background-border)\n border: 0\n\n.centered\n text-align: center\n\n// Links\na\n text-decoration: underline\n\n color: var(--color-link)\n text-decoration-color: var(--color-link-underline)\n\n &:hover\n color: var(--color-link--hover)\n text-decoration-color: var(--color-link-underline--hover)\n &.muted-link\n color: inherit\n &:hover\n color: var(--color-link)\n text-decoration-color: var(--color-link-underline--hover)\n","// This file contains the styles for the overall layouting of the documentation\n// skeleton, including the responsive changes as well as sidebar toggles.\n//\n// This is implemented as a mobile-last design, which isn't ideal, but it is\n// reasonably good-enough and I got pretty tired by the time I'd finished this\n// to move the rules around to fix this. Shouldn't take more than 3-4 hours,\n// if you know what you're doing tho.\n\n// HACK: Not all browsers account for the scrollbar width in media queries.\n// This results in horizontal scrollbars in the breakpoint where we go\n// from displaying everything to hiding the ToC. We accomodate for this by\n// adding a bit of padding to the TOC drawer, disabling the horizontal\n// scrollbar and allowing the scrollbars to cover the padding.\n// https://www.456bereastreet.com/archive/201301/media_query_width_and_vertical_scrollbars/\n\n// HACK: Always having the scrollbar visible, prevents certain browsers from\n// causing the content to stutter horizontally between taller-than-viewport and\n// not-taller-than-viewport pages.\n\nhtml\n overflow-x: hidden\n overflow-y: scroll\n scroll-behavior: smooth\n\n.sidebar-scroll, .toc-scroll, article[role=main] *\n // Override Firefox scrollbar style\n scrollbar-width: thin\n scrollbar-color: var(--color-foreground-border) transparent\n\n // Override Chrome scrollbar styles\n &::-webkit-scrollbar\n width: 0.25rem\n height: 0.25rem\n &::-webkit-scrollbar-thumb\n background-color: var(--color-foreground-border)\n border-radius: 0.125rem\n\n//\n// Overalls\n//\nhtml,\nbody\n height: 100%\n color: var(--color-foreground-primary)\n background: var(--color-background-primary)\n\narticle\n color: var(--color-content-foreground)\n background: var(--color-content-background)\n overflow-wrap: break-word\n\n.page\n display: flex\n // fill the viewport for pages with little content.\n min-height: 100%\n\n.mobile-header\n width: 100%\n height: var(--header-height)\n background-color: var(--color-header-background)\n color: var(--color-header-text)\n border-bottom: 1px solid var(--color-header-border)\n\n // Looks like sub-script/super-script have this, and we need this to\n // be \"on top\" of those.\n z-index: 10\n\n // We don't show the header on large screens.\n display: none\n\n // Add shadow when scrolled\n &.scrolled\n border-bottom: none\n box-shadow: 0 0 0.2rem rgba(0, 0, 0, 0.1), 0 0.2rem 0.4rem rgba(0, 0, 0, 0.2)\n\n .header-center\n a\n color: var(--color-header-text)\n text-decoration: none\n\n.main\n display: flex\n flex: 1\n\n// Sidebar (left) also covers the entire left portion of screen.\n.sidebar-drawer\n box-sizing: border-box\n\n border-right: 1px solid var(--color-sidebar-background-border)\n background: var(--color-sidebar-background)\n\n display: flex\n justify-content: flex-end\n // These next two lines took me two days to figure out.\n width: calc((100% - #{$full-width}) / 2 + #{$sidebar-width})\n min-width: $sidebar-width\n\n// Scroll-along sidebars\n.sidebar-container,\n.toc-drawer\n box-sizing: border-box\n width: $sidebar-width\n\n.toc-drawer\n background: var(--color-toc-background)\n // See HACK described on top of this document\n padding-right: 1rem\n\n.sidebar-sticky,\n.toc-sticky\n position: sticky\n top: 0\n height: min(100%, 100vh)\n height: 100vh\n\n display: flex\n flex-direction: column\n\n.sidebar-scroll,\n.toc-scroll\n flex-grow: 1\n flex-shrink: 1\n\n overflow: auto\n scroll-behavior: smooth\n\n// Central items.\n.content\n padding: 0 $content-padding\n width: $content-width\n\n display: flex\n flex-direction: column\n justify-content: space-between\n\n.icon\n display: inline-block\n height: 1rem\n width: 1rem\n svg\n width: 100%\n height: 100%\n\n//\n// Accommodate announcement banner\n//\n.announcement\n background-color: var(--color-announcement-background)\n color: var(--color-announcement-text)\n\n height: var(--header-height)\n display: flex\n align-items: center\n overflow-x: auto\n & + .page\n min-height: calc(100% - var(--header-height))\n\n.announcement-content\n box-sizing: border-box\n padding: 0.5rem\n min-width: 100%\n white-space: nowrap\n text-align: center\n\n a\n color: var(--color-announcement-text)\n text-decoration-color: var(--color-announcement-text)\n\n &:hover\n color: var(--color-announcement-text)\n text-decoration-color: var(--color-link--hover)\n\n////////////////////////////////////////////////////////////////////////////////\n// Toggles for theme\n////////////////////////////////////////////////////////////////////////////////\n.no-js .theme-toggle-container // don't show theme toggle if there's no JS\n display: none\n\n.theme-toggle-container\n vertical-align: middle\n\n.theme-toggle\n cursor: pointer\n border: none\n padding: 0\n background: transparent\n\n.theme-toggle svg\n vertical-align: middle\n height: 1rem\n width: 1rem\n color: var(--color-foreground-primary)\n display: none\n\n.theme-toggle-header\n float: left\n padding: 1rem 0.5rem\n\n////////////////////////////////////////////////////////////////////////////////\n// Toggles for elements\n////////////////////////////////////////////////////////////////////////////////\n.toc-overlay-icon, .nav-overlay-icon\n display: none\n cursor: pointer\n\n .icon\n color: var(--color-foreground-secondary)\n height: 1rem\n width: 1rem\n\n.toc-header-icon, .nav-overlay-icon\n // for when we set display: flex\n justify-content: center\n align-items: center\n\n.toc-content-icon\n height: 1.5rem\n width: 1.5rem\n\n.content-icon-container\n float: right\n display: flex\n margin-top: 1.5rem\n margin-left: 1rem\n margin-bottom: 1rem\n gap: 0.5rem\n\n .edit-this-page svg\n color: inherit\n height: 1rem\n width: 1rem\n\n.sidebar-toggle\n position: absolute\n display: none\n// \n.sidebar-toggle[name=\"__toc\"]\n left: 20px\n.sidebar-toggle:checked\n left: 40px\n// \n\n.overlay\n position: fixed\n top: 0\n width: 0\n height: 0\n\n transition: width 0ms, height 0ms, opacity 250ms ease-out\n\n opacity: 0\n background-color: rgba(0, 0, 0, 0.54)\n.sidebar-overlay\n z-index: 20\n.toc-overlay\n z-index: 40\n\n// Keep things on top and smooth.\n.sidebar-drawer\n z-index: 30\n transition: left 250ms ease-in-out\n.toc-drawer\n z-index: 50\n transition: right 250ms ease-in-out\n\n// Show the Sidebar\n#__navigation:checked\n & ~ .sidebar-overlay\n width: 100%\n height: 100%\n opacity: 1\n & ~ .page\n .sidebar-drawer\n top: 0\n left: 0\n // Show the toc sidebar\n#__toc:checked\n & ~ .toc-overlay\n width: 100%\n height: 100%\n opacity: 1\n & ~ .page\n .toc-drawer\n top: 0\n right: 0\n\n////////////////////////////////////////////////////////////////////////////////\n// Back to top\n////////////////////////////////////////////////////////////////////////////////\n.back-to-top\n text-decoration: none\n\n display: none\n position: fixed\n left: 0\n top: 1rem\n padding: 0.5rem\n padding-right: 0.75rem\n border-radius: 1rem\n font-size: 0.8125rem\n\n background: var(--color-background-primary)\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), #6b728080 0px 0px 1px 0px\n\n z-index: 10\n\n margin-left: 50%\n transform: translateX(-50%)\n svg\n height: 1rem\n width: 1rem\n fill: currentColor\n display: inline-block\n\n span\n margin-left: 0.25rem\n\n .show-back-to-top &\n display: flex\n align-items: center\n\n////////////////////////////////////////////////////////////////////////////////\n// Responsive layouting\n////////////////////////////////////////////////////////////////////////////////\n// Make things a bit bigger on bigger screens.\n@media (min-width: $full-width + $sidebar-width)\n html\n font-size: 110%\n\n@media (max-width: $full-width)\n // Collapse \"toc\" into the icon.\n .toc-content-icon\n display: flex\n .toc-drawer\n position: fixed\n height: 100vh\n top: 0\n right: -$sidebar-width\n border-left: 1px solid var(--color-background-muted)\n .toc-tree\n border-left: none\n font-size: var(--toc-font-size--mobile)\n\n // Accomodate for a changed content width.\n .sidebar-drawer\n width: calc((100% - #{$full-width - $sidebar-width}) / 2 + #{$sidebar-width})\n\n@media (max-width: $full-width - $sidebar-width)\n // Collapse \"navigation\".\n .nav-overlay-icon\n display: flex\n .sidebar-drawer\n position: fixed\n height: 100vh\n width: $sidebar-width\n\n top: 0\n left: -$sidebar-width\n\n // Swap which icon is visible.\n .toc-header-icon\n display: flex\n .toc-content-icon, .theme-toggle-content\n display: none\n .theme-toggle-header\n display: block\n\n // Show the header.\n .mobile-header\n position: sticky\n top: 0\n display: flex\n justify-content: space-between\n align-items: center\n\n .header-left,\n .header-right\n display: flex\n height: var(--header-height)\n padding: 0 var(--header-padding)\n label\n height: 100%\n width: 100%\n user-select: none\n\n .nav-overlay-icon .icon,\n .theme-toggle svg\n height: 1.25rem\n width: 1.25rem\n\n // Add a scroll margin for the content\n :target\n scroll-margin-top: var(--header-height)\n\n // Show back-to-top below the header\n .back-to-top\n top: calc(var(--header-height) + 0.5rem)\n\n // Center the page, and accommodate for the header.\n .page\n flex-direction: column\n justify-content: center\n .content\n margin-left: auto\n margin-right: auto\n\n@media (max-width: $content-width + 2* $content-padding)\n // Content should respect window limits.\n .content\n width: 100%\n overflow-x: auto\n\n@media (max-width: $content-width)\n .content\n padding: 0 $content-padding--small\n // Don't float sidebars to the right.\n article aside.sidebar\n float: none\n width: 100%\n margin: 1rem 0\n","//\n// The design here is strongly inspired by mkdocs-material.\n.admonition, .topic\n margin: 1rem auto\n padding: 0 0.5rem 0.5rem 0.5rem\n\n background: var(--color-admonition-background)\n\n border-radius: 0.2rem\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), 0 0 0.0625rem rgba(0, 0, 0, 0.1)\n\n font-size: var(--admonition-font-size)\n\n overflow: hidden\n page-break-inside: avoid\n\n // First element should have no margin, since the title has it.\n > :nth-child(2)\n margin-top: 0\n\n // Last item should have no margin, since we'll control that w/ padding\n > :last-child\n margin-bottom: 0\n\n.admonition p.admonition-title,\np.topic-title\n position: relative\n margin: 0 -0.5rem 0.5rem\n padding-left: 2rem\n padding-right: .5rem\n padding-top: .4rem\n padding-bottom: .4rem\n\n font-weight: 500\n font-size: var(--admonition-title-font-size)\n line-height: 1.3\n\n // Our fancy icon\n &::before\n content: \"\"\n position: absolute\n left: 0.5rem\n width: 1rem\n height: 1rem\n\n// Default styles\np.admonition-title\n background-color: var(--color-admonition-title-background)\n &::before\n background-color: var(--color-admonition-title)\n mask-image: var(--icon-admonition-default)\n mask-repeat: no-repeat\n\np.topic-title\n background-color: var(--color-topic-title-background)\n &::before\n background-color: var(--color-topic-title)\n mask-image: var(--icon-topic-default)\n mask-repeat: no-repeat\n\n//\n// Variants\n//\n.admonition\n border-left: 0.2rem solid var(--color-admonition-title)\n\n @each $type, $value in $admonitions\n &.#{$type}\n border-left-color: var(--color-admonition-title--#{$type})\n > .admonition-title\n background-color: var(--color-admonition-title-background--#{$type})\n &::before\n background-color: var(--color-admonition-title--#{$type})\n mask-image: var(--icon-#{nth($value, 2)})\n\n.admonition-todo > .admonition-title\n text-transform: uppercase\n","// This file stylizes the API documentation (stuff generated by autodoc). It's\n// deeply nested due to how autodoc structures the HTML without enough classes\n// to select the relevant items.\n\n// API docs!\ndl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)\n // Tweak the spacing of all the things!\n dd\n margin-left: 2rem\n > :first-child\n margin-top: 0.125rem\n > :last-child\n margin-bottom: 0.75rem\n\n // This is used for the arguments\n .field-list\n margin-bottom: 0.75rem\n\n // \"Headings\" (like \"Parameters\" and \"Return\")\n > dt\n text-transform: uppercase\n font-size: var(--font-size--small)\n\n dd:empty\n margin-bottom: 0.5rem\n dd > ul\n margin-left: -1.2rem\n > li\n > p:nth-child(2)\n margin-top: 0\n // When the last-empty-paragraph follows a paragraph, it doesn't need\n // to augument the existing spacing.\n > p + p:last-child:empty\n margin-top: 0\n margin-bottom: 0\n\n // Colorize the elements\n > dt\n color: var(--color-api-overall)\n\n.sig:not(.sig-inline)\n font-weight: bold\n\n font-size: var(--api-font-size)\n font-family: var(--font-stack--monospace)\n\n margin-left: -0.25rem\n margin-right: -0.25rem\n padding-top: 0.25rem\n padding-bottom: 0.25rem\n padding-right: 0.5rem\n\n // These are intentionally em, to properly match the font size.\n padding-left: 3em\n text-indent: -2.5em\n\n border-radius: 0.25rem\n\n background: var(--color-api-background)\n transition: background 100ms ease-out\n\n &:hover\n background: var(--color-api-background-hover)\n\n // adjust the size of the [source] link on the right.\n a.reference\n .viewcode-link\n font-weight: normal\n width: 3.5rem\n\nem.property\n font-style: normal\n &:first-child\n color: var(--color-api-keyword)\n.sig-name\n color: var(--color-api-name)\n.sig-prename\n font-weight: normal\n color: var(--color-api-pre-name)\n.sig-paren\n color: var(--color-api-paren)\n.sig-param\n font-style: normal\n\n.versionmodified\n font-style: italic\ndiv.versionadded, div.versionchanged, div.deprecated\n p\n margin-top: 0.125rem\n margin-bottom: 0.125rem\n\n// Align the [docs] and [source] to the right.\n.viewcode-link, .viewcode-back\n float: right\n text-align: right\n",".line-block\n margin-top: 0.5rem\n margin-bottom: 0.75rem\n .line-block\n margin-top: 0rem\n margin-bottom: 0rem\n padding-left: 1rem\n","// Captions\narticle p.caption,\ntable > caption,\n.code-block-caption\n font-size: var(--font-size--small)\n text-align: center\n\n// Caption above a TOCTree\n.toctree-wrapper.compound\n .caption, :not(.caption) > .caption-text\n font-size: var(--font-size--small)\n text-transform: uppercase\n\n text-align: initial\n margin-bottom: 0\n\n > ul\n margin-top: 0\n margin-bottom: 0\n","// Inline code\ncode.literal, .sig-inline\n background: var(--color-inline-code-background)\n border-radius: 0.2em\n // Make the font smaller, and use padding to recover.\n font-size: var(--font-size--small--2)\n padding: 0.1em 0.2em\n\n pre.literal-block &\n font-size: inherit\n padding: 0\n\n p &\n border: 1px solid var(--color-background-border)\n\n.sig-inline\n font-family: var(--font-stack--monospace)\n\n// Code and Literal Blocks\n$code-spacing-vertical: 0.625rem\n$code-spacing-horizontal: 0.875rem\n\n// Wraps every literal block + line numbers.\ndiv[class*=\" highlight-\"],\ndiv[class^=\"highlight-\"]\n margin: 1em 0\n display: flex\n\n .table-wrapper\n margin: 0\n padding: 0\n\npre\n margin: 0\n padding: 0\n overflow: auto\n\n // Needed to have more specificity than pygments' \"pre\" selector. :(\n article[role=\"main\"] .highlight &\n line-height: 1.5\n\n &.literal-block,\n .highlight &\n font-size: var(--code-font-size)\n padding: $code-spacing-vertical $code-spacing-horizontal\n\n // Make it look like all the other blocks.\n &.literal-block\n margin-top: 1rem\n margin-bottom: 1rem\n\n border-radius: 0.2rem\n background-color: var(--color-code-background)\n color: var(--color-code-foreground)\n\n// All code is always contained in this.\n.highlight\n width: 100%\n border-radius: 0.2rem\n\n // Make line numbers and prompts un-selectable.\n .gp, span.linenos\n user-select: none\n pointer-events: none\n\n // Expand the line-highlighting.\n .hll\n display: block\n margin-left: -$code-spacing-horizontal\n margin-right: -$code-spacing-horizontal\n padding-left: $code-spacing-horizontal\n padding-right: $code-spacing-horizontal\n\n/* Make code block captions be nicely integrated */\n.code-block-caption\n display: flex\n padding: $code-spacing-vertical $code-spacing-horizontal\n\n border-radius: 0.25rem\n border-bottom-left-radius: 0\n border-bottom-right-radius: 0\n font-weight: 300\n border-bottom: 1px solid\n\n background-color: var(--color-code-background)\n color: var(--color-code-foreground)\n border-color: var(--color-background-border)\n\n + div[class]\n margin-top: 0\n pre\n border-top-left-radius: 0\n border-top-right-radius: 0\n\n// When `html_codeblock_linenos_style` is table.\n.highlighttable\n width: 100%\n display: block\n tbody\n display: block\n\n tr\n display: flex\n\n // Line numbers\n td.linenos\n background-color: var(--color-code-background)\n color: var(--color-code-foreground)\n padding: $code-spacing-vertical $code-spacing-horizontal\n padding-right: 0\n border-top-left-radius: 0.2rem\n border-bottom-left-radius: 0.2rem\n\n .linenodiv\n padding-right: $code-spacing-horizontal\n font-size: var(--code-font-size)\n box-shadow: -0.0625rem 0 var(--color-foreground-border) inset\n\n // Actual code\n td.code\n padding: 0\n display: block\n flex: 1\n overflow: hidden\n\n .highlight\n border-top-left-radius: 0\n border-bottom-left-radius: 0\n\n// When `html_codeblock_linenos_style` is inline.\n.highlight\n span.linenos\n display: inline-block\n padding-left: 0\n padding-right: $code-spacing-horizontal\n margin-right: $code-spacing-horizontal\n box-shadow: -0.0625rem 0 var(--color-foreground-border) inset\n","// Inline Footnote Reference\n.footnote-reference\n font-size: var(--font-size--small--4)\n vertical-align: super\n\n// Definition list, listing the content of each note.\n// docutils <= 0.17\ndl.footnote.brackets\n font-size: var(--font-size--small)\n color: var(--color-foreground-secondary)\n\n display: grid\n grid-template-columns: max-content auto\n dt\n margin: 0\n > .fn-backref\n margin-left: 0.25rem\n\n &:after\n content: \":\"\n\n .brackets\n &:before\n content: \"[\"\n &:after\n content: \"]\"\n\n dd\n margin: 0\n padding: 0 1rem\n\n// docutils >= 0.18\naside.footnote\n font-size: var(--font-size--small)\n color: var(--color-foreground-secondary)\n\naside.footnote > span,\ndiv.citation > span\n float: left\n font-weight: 500\n padding-right: 0.25rem\n\naside.footnote > p,\ndiv.citation > p\n margin-left: 2rem\n","//\n// Figures\n//\nimg\n box-sizing: border-box\n max-width: 100%\n height: auto\n\narticle\n figure, .figure\n border-radius: 0.2rem\n\n margin: 0\n :last-child\n margin-bottom: 0\n\n .align-left\n float: left\n clear: left\n margin: 0 1rem 1rem\n\n .align-right\n float: right\n clear: right\n margin: 0 1rem 1rem\n\n .align-default,\n .align-center\n display: block\n text-align: center\n margin-left: auto\n margin-right: auto\n\n // WELL, table needs to be stylised like a table.\n table.align-default\n display: table\n text-align: initial\n",".genindex-jumpbox, .domainindex-jumpbox\n border-top: 1px solid var(--color-background-border)\n border-bottom: 1px solid var(--color-background-border)\n padding: 0.25rem\n\n.genindex-section, .domainindex-section\n h2\n margin-top: 0.75rem\n margin-bottom: 0.5rem\n ul\n margin-top: 0\n margin-bottom: 0\n","ul,\nol\n padding-left: 1.2rem\n\n // Space lists out like paragraphs\n margin-top: 1rem\n margin-bottom: 1rem\n // reduce margins within li.\n li\n > p:first-child\n margin-top: 0.25rem\n margin-bottom: 0.25rem\n\n > p:last-child\n margin-top: 0.25rem\n\n > ul,\n > ol\n margin-top: 0.5rem\n margin-bottom: 0.5rem\n\nol\n &.arabic\n list-style: decimal\n &.loweralpha\n list-style: lower-alpha\n &.upperalpha\n list-style: upper-alpha\n &.lowerroman\n list-style: lower-roman\n &.upperroman\n list-style: upper-roman\n\n// Don't space lists out when they're \"simple\" or in a `.. toctree::`\n.simple,\n.toctree-wrapper\n li\n > ul,\n > ol\n margin-top: 0\n margin-bottom: 0\n\n// Definition Lists\n.field-list,\n.option-list,\ndl:not([class]),\ndl.simple,\ndl.footnote,\ndl.glossary\n dt\n font-weight: 500\n margin-top: 0.25rem\n + dt\n margin-top: 0\n\n .classifier::before\n content: \":\"\n margin-left: 0.2rem\n margin-right: 0.2rem\n\n dd\n > p:first-child,\n ul\n margin-top: 0.125rem\n\n ul\n margin-bottom: 0.125rem\n",".math-wrapper\n width: 100%\n overflow-x: auto\n\ndiv.math\n position: relative\n text-align: center\n\n .headerlink,\n &:focus .headerlink\n display: none\n\n &:hover .headerlink\n display: inline-block\n\n span.eqno\n position: absolute\n right: 0.5rem\n top: 50%\n transform: translate(0, -50%)\n z-index: 1\n","// Abbreviations\nabbr[title]\n cursor: help\n\n// \"Problematic\" content, as identified by Sphinx\n.problematic\n color: var(--color-problematic)\n\n// Keyboard / Mouse \"instructions\"\nkbd:not(.compound)\n margin: 0 0.2rem\n padding: 0 0.2rem\n border-radius: 0.2rem\n border: 1px solid var(--color-foreground-border)\n color: var(--color-foreground-primary)\n vertical-align: text-bottom\n\n font-size: var(--font-size--small--3)\n display: inline-block\n\n box-shadow: 0 0.0625rem 0 rgba(0, 0, 0, 0.2), inset 0 0 0 0.125rem var(--color-background-primary)\n\n background-color: var(--color-background-secondary)\n\n// Blockquote\nblockquote\n border-left: 4px solid var(--color-background-border)\n background: var(--color-background-secondary)\n\n margin-left: 0\n margin-right: 0\n padding: 0.5rem 1rem\n\n .attribution\n font-weight: 600\n text-align: right\n\n &.pull-quote,\n &.highlights\n font-size: 1.25em\n\n &.epigraph,\n &.pull-quote\n border-left-width: 0\n border-radius: 0.5rem\n\n &.highlights\n border-left-width: 0\n background: transparent\n\n// Center align embedded-in-text images\np .reference img\n vertical-align: middle\n","p.rubric\n line-height: 1.25\n font-weight: bold\n font-size: 1.125em\n\n // For Numpy-style documentation that's got rubrics within it.\n // https://github.com/pradyunsg/furo/discussions/505\n dd &\n line-height: inherit\n font-weight: inherit\n\n font-size: var(--font-size--small)\n text-transform: uppercase\n","article .sidebar\n float: right\n clear: right\n width: 30%\n\n margin-left: 1rem\n margin-right: 0\n\n border-radius: 0.2rem\n background-color: var(--color-background-secondary)\n border: var(--color-background-border) 1px solid\n\n > *\n padding-left: 1rem\n padding-right: 1rem\n\n > ul, > ol // lists need additional padding, because bullets.\n padding-left: 2.2rem\n\n .sidebar-title\n margin: 0\n padding: 0.5rem 1rem\n border-bottom: var(--color-background-border) 1px solid\n\n font-weight: 500\n\n// TODO: subtitle\n// TODO: dedicated variables?\n",".table-wrapper\n width: 100%\n overflow-x: auto\n margin-top: 1rem\n margin-bottom: 0.5rem\n padding: 0.2rem 0.2rem 0.75rem\n\ntable.docutils\n border-radius: 0.2rem\n border-spacing: 0\n border-collapse: collapse\n\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), 0 0 0.0625rem rgba(0, 0, 0, 0.1)\n\n th\n background: var(--color-table-header-background)\n\n td,\n th\n // Space things out properly\n padding: 0 0.25rem\n\n // Get the borders looking just-right.\n border-left: 1px solid var(--color-table-border)\n border-right: 1px solid var(--color-table-border)\n border-bottom: 1px solid var(--color-table-border)\n\n p\n margin: 0.25rem\n\n &:first-child\n border-left: none\n &:last-child\n border-right: none\n\n // MyST-parser tables set these classes for control of column alignment\n &.text-left\n text-align: left\n &.text-right\n text-align: right\n &.text-center\n text-align: center\n",":target\n scroll-margin-top: 0.5rem\n\n@media (max-width: $full-width - $sidebar-width)\n :target\n scroll-margin-top: calc(0.5rem + var(--header-height))\n\n // When a heading is selected\n section > span:target\n scroll-margin-top: calc(0.8rem + var(--header-height))\n\n// Permalinks\n.headerlink\n font-weight: 100\n user-select: none\n\nh1,\nh2,\nh3,\nh4,\nh5,\nh6,\ndl dt,\np.caption,\nfigcaption p,\ntable > caption,\n.code-block-caption\n > .headerlink\n margin-left: 0.5rem\n visibility: hidden\n &:hover > .headerlink\n visibility: visible\n\n // Don't change to link-like, if someone adds the contents directive.\n > .toc-backref\n color: inherit\n text-decoration-line: none\n\n// Figure and table captions are special.\nfigure:hover > figcaption > p > .headerlink,\ntable:hover > caption > .headerlink\n visibility: visible\n\n:target >, // Regular section[id] style anchors\nspan:target ~ // Non-regular span[id] style \"extra\" anchors\n h1,\n h2,\n h3,\n h4,\n h5,\n h6\n &:nth-of-type(1)\n background-color: var(--color-highlight-on-target)\n // .headerlink\n // visibility: visible\n code.literal\n background-color: transparent\n\ntable:target > caption,\nfigure:target\n background-color: var(--color-highlight-on-target)\n\n// Inline page contents\n.this-will-duplicate-information-and-it-is-still-useful-here li :target\n background-color: var(--color-highlight-on-target)\n\n// Code block permalinks\n.literal-block-wrapper:target .code-block-caption\n background-color: var(--color-highlight-on-target)\n\n// When a definition list item is selected\n//\n// There isn't really an alternative to !important here, due to the\n// high-specificity of API documentation's selector.\ndt:target\n background-color: var(--color-highlight-on-target) !important\n\n// When a footnote reference is selected\n.footnote > dt:target + dd,\n.footnote-reference:target\n background-color: var(--color-highlight-on-target)\n",".guilabel\n background-color: var(--color-guilabel-background)\n border: 1px solid var(--color-guilabel-border)\n color: var(--color-guilabel-text)\n\n padding: 0 0.3em\n border-radius: 0.5em\n font-size: 0.9em\n","// This file contains the styles used for stylizing the footer that's shown\n// below the content.\n\nfooter\n font-size: var(--font-size--small)\n display: flex\n flex-direction: column\n\n margin-top: 2rem\n\n// Bottom of page information\n.bottom-of-page\n display: flex\n align-items: center\n justify-content: space-between\n\n margin-top: 1rem\n padding-top: 1rem\n padding-bottom: 1rem\n\n color: var(--color-foreground-secondary)\n border-top: 1px solid var(--color-background-border)\n\n line-height: 1.5\n\n @media (max-width: $content-width)\n text-align: center\n flex-direction: column-reverse\n gap: 0.25rem\n\n .left-details\n font-size: var(--font-size--small)\n\n .right-details\n display: flex\n flex-direction: column\n gap: 0.25rem\n text-align: right\n\n .icons\n display: flex\n justify-content: flex-end\n gap: 0.25rem\n font-size: 1rem\n\n a\n text-decoration: none\n\n svg,\n img\n font-size: 1.125rem\n height: 1em\n width: 1em\n\n// Next/Prev page information\n.related-pages\n a\n display: flex\n align-items: center\n\n text-decoration: none\n &:hover .page-info .title\n text-decoration: underline\n color: var(--color-link)\n text-decoration-color: var(--color-link-underline)\n\n svg.furo-related-icon,\n svg.furo-related-icon > use\n flex-shrink: 0\n\n color: var(--color-foreground-border)\n\n width: 0.75rem\n height: 0.75rem\n margin: 0 0.5rem\n\n &.next-page\n max-width: 50%\n\n float: right\n clear: right\n text-align: right\n\n &.prev-page\n max-width: 50%\n\n float: left\n clear: left\n\n svg\n transform: rotate(180deg)\n\n.page-info\n display: flex\n flex-direction: column\n overflow-wrap: anywhere\n\n .next-page &\n align-items: flex-end\n\n .context\n display: flex\n align-items: center\n\n padding-bottom: 0.1rem\n\n color: var(--color-foreground-muted)\n font-size: var(--font-size--small)\n text-decoration: none\n","// This file contains the styles for the contents of the left sidebar, which\n// contains the navigation tree, logo, search etc.\n\n////////////////////////////////////////////////////////////////////////////////\n// Brand on top of the scrollable tree.\n////////////////////////////////////////////////////////////////////////////////\n.sidebar-brand\n display: flex\n flex-direction: column\n flex-shrink: 0\n\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n text-decoration: none\n\n.sidebar-brand-text\n color: var(--color-sidebar-brand-text)\n overflow-wrap: break-word\n margin: var(--sidebar-item-spacing-vertical) 0\n font-size: 1.5rem\n\n.sidebar-logo-container\n margin: var(--sidebar-item-spacing-vertical) 0\n\n.sidebar-logo\n margin: 0 auto\n display: block\n max-width: 100%\n\n////////////////////////////////////////////////////////////////////////////////\n// Search\n////////////////////////////////////////////////////////////////////////////////\n.sidebar-search-container\n display: flex\n align-items: center\n margin-top: var(--sidebar-search-space-above)\n\n position: relative\n\n background: var(--color-sidebar-search-background)\n &:hover,\n &:focus-within\n background: var(--color-sidebar-search-background--focus)\n\n &::before\n content: \"\"\n position: absolute\n left: var(--sidebar-item-spacing-horizontal)\n width: var(--sidebar-search-icon-size)\n height: var(--sidebar-search-icon-size)\n\n background-color: var(--color-sidebar-search-icon)\n mask-image: var(--icon-search)\n\n.sidebar-search\n box-sizing: border-box\n\n border: none\n border-top: 1px solid var(--color-sidebar-search-border)\n border-bottom: 1px solid var(--color-sidebar-search-border)\n\n padding-top: var(--sidebar-search-input-spacing-vertical)\n padding-bottom: var(--sidebar-search-input-spacing-vertical)\n padding-right: var(--sidebar-search-input-spacing-horizontal)\n padding-left: calc(var(--sidebar-item-spacing-horizontal) + var(--sidebar-search-input-spacing-horizontal) + var(--sidebar-search-icon-size))\n\n width: 100%\n\n color: var(--color-sidebar-search-foreground)\n background: transparent\n z-index: 10\n\n &:focus\n outline: none\n\n &::placeholder\n font-size: var(--sidebar-search-input-font-size)\n\n//\n// Hide Search Matches link\n//\n#searchbox .highlight-link\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal) 0\n margin: 0\n text-align: center\n\n a\n color: var(--color-sidebar-search-icon)\n font-size: var(--font-size--small--2)\n\n////////////////////////////////////////////////////////////////////////////////\n// Structure/Skeleton of the navigation tree (left)\n////////////////////////////////////////////////////////////////////////////////\n.sidebar-tree\n font-size: var(--sidebar-item-font-size)\n margin-top: var(--sidebar-tree-space-above)\n margin-bottom: var(--sidebar-item-spacing-vertical)\n\n ul\n padding: 0\n margin-top: 0\n margin-bottom: 0\n\n display: flex\n flex-direction: column\n\n list-style: none\n\n li\n position: relative\n margin: 0\n\n > ul\n margin-left: var(--sidebar-item-spacing-horizontal)\n\n .icon\n color: var(--color-sidebar-link-text)\n\n .reference\n box-sizing: border-box\n color: var(--color-sidebar-link-text)\n\n // Fill the parent.\n display: inline-block\n line-height: var(--sidebar-item-line-height)\n text-decoration: none\n\n // Don't allow long words to cause wrapping.\n overflow-wrap: anywhere\n\n height: 100%\n width: 100%\n\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n\n &:hover\n background: var(--color-sidebar-item-background--hover)\n\n // Add a nice little \"external-link\" arrow here.\n &.external::after\n content: url('data:image/svg+xml,')\n margin: 0 0.25rem\n vertical-align: middle\n color: var(--color-sidebar-link-text)\n\n // Make the current page reference bold.\n .current-page > .reference\n font-weight: bold\n\n label\n position: absolute\n top: 0\n right: 0\n height: var(--sidebar-item-height)\n width: var(--sidebar-expander-width)\n\n cursor: pointer\n user-select: none\n\n display: flex\n justify-content: center\n align-items: center\n\n .caption, :not(.caption) > .caption-text\n font-size: var(--sidebar-caption-font-size)\n color: var(--color-sidebar-caption-text)\n\n font-weight: bold\n text-transform: uppercase\n\n margin: var(--sidebar-caption-space-above) 0 0 0\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n\n // If it has children, add a bit more padding to wrap the content to avoid\n // overlapping with the