Deploying to gh-pages from @ 926c21d 🚀

Author: mballance

.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
-# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 40c048cdf8acc7862dbc406040f89949
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: ac2be28c1b899113d6ee482cc705056b
 tags: 645f666f9bcd5a90fca523b33c5a78b7

_images/IVPM_System_Diagram.png

@@ -8,14 +8,14 @@ Installing IVPM
 IVPM must be installed before it can be used to work with a project. Typically,
 the easiest approach is to install IVPM as a user-installed package:
 
-.. code-block:: bash
+..code-block:: bash
 
     % python3 -m pip install --user ivpm
 
 Once this is done, you can invoke IVPM either via the entry-point script (ivpm)
 or as a Python module:
 
-.. code-block:: bash
+..code-block:: bash
 
     % ivpm --help
     % python3 -m ivpm --help
@@ -29,7 +29,7 @@ for the project.
 The IVPM project, itself, is IVPM-enabled. The steps to fetch and initialize
 the project are shown below (assuming ivpm has already been installed):
 
-.. code-block:: bash
+..code-block:: bash
 
     % git clone https://github.com/fvutils/ivpm
     % cd ivpm
@@ -41,7 +41,6 @@ from that server will fail. Git projects can be cloned using https
 (ie anonymously) by running `ivpm update -a`.
 
 IVPM performs the following tasks as a part of the `update` operation:
-
 - Fetches the source for each dependent project (eg .git, .tar.gz, .jar, etc)
 - Identifies dependent projects that are, themselves, IVPM-enabled and 
   determines sub-dependencies

_images/ivpm_system.excalidraw.svg

@@ -9,7 +9,7 @@ lightweight project-local package manager. It excels at
 managing projects where dependencies are co-developed with
 the project. 
 
-.. image:: imgs/ivpm_system.excalidraw.svg
+.. image:: imgs/IVPM_System_Diagram.png
 
 Let's look at a simple example. A System-on-Chip 
 (SoC) design targeting an FPGA or an ASIC is composed of

_sources/getting_started.rst.txt

@@ -15,9 +15,9 @@ Commands
 YAML File Format
 ================
 
-.. jsonschema:: ../../src/ivpm/share/ivpm.json#/defs/package-def
+.. jsonschema:: ../../src/ivpm/schema/ivpm.json#/defs/package-def
 
-.. jsonschema:: ../../src/ivpm/share/ivpm.json#/defs/dep-set
+.. jsonschema:: ../../src/ivpm/schema/ivpm.json#/defs/dep-set
 
-.. jsonschema:: ../../src/ivpm/share/ivpm.json#/defs/package-dep
+.. jsonschema:: ../../src/ivpm/schema/ivpm.json#/defs/package-dep
 

_sources/introduction.rst.txt

@@ -1,5 +1,12 @@
 /*
+ * basic.css
+ * ~~~~~~~~~
+ *
  * Sphinx stylesheet -- basic theme.
+ *
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
  */
 
 /* -- main layout ----------------------------------------------------------- */
@@ -108,11 +115,15 @@ img {
 /* -- search page ----------------------------------------------------------- */
 
 ul.search {
-    margin-top: 10px;
+    margin: 10px 0 0 20px;
+    padding: 0;
 }
 
 ul.search li {
-    padding: 5px 0;
+    padding: 5px 0 5px 20px;
+    background-image: url(file.png);
+    background-repeat: no-repeat;
+    background-position: 0 7px;
 }
 
 ul.search li a {
@@ -741,6 +752,14 @@ abbr, acronym {
     cursor: help;
 }
 
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {

_sources/reference.rst.txt

@@ -1,5 +1,12 @@
 /*
+ * doctools.js
+ * ~~~~~~~~~~~
+ *
  * Base JavaScript utilities for all Sphinx HTML documentation.
+ *
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
  */
 "use strict";
 

_static/basic.css

@@ -1,6 +1,13 @@
 /*
+ * 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-2024 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"];

_static/doctools.js

@@ -1,5 +1,12 @@
 /*
+ * searchtools.js
+ * ~~~~~~~~~~~~~~~~
+ *
  * Sphinx JavaScript utilities for the full-text search.
+ *
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
  */
 "use strict";
 
@@ -13,7 +20,7 @@ if (typeof Scorer === "undefined") {
     // and returns the new score.
     /*
     score: result => {
-      const [docname, title, anchor, descr, score, filename, kind] = result
+      const [docname, title, anchor, descr, score, filename] = result
       return score
     },
     */
@@ -40,14 +47,6 @@ if (typeof Scorer === "undefined") {
   };
 }
 
-// Global search result kind enum, used by themes to style search results.
-class SearchResultKind {
-    static get index() { return  "index"; }
-    static get object() { return "object"; }
-    static get text() { return "text"; }
-    static get title() { return "title"; }
-}
-
 const _removeChildren = (element) => {
   while (element && element.lastChild) element.removeChild(element.lastChild);
 };
@@ -65,13 +64,9 @@ const _displayItem = (item, searchTerms, highlightTerms) => {
   const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
   const contentRoot = document.documentElement.dataset.content_root;
 
-  const [docName, title, anchor, descr, score, _filename, kind] = item;
+  const [docName, title, anchor, descr, score, _filename] = item;
 
   let listItem = document.createElement("li");
-  // Add a class representing the item's type:
-  // can be used by a theme's CSS selector for styling
-  // See SearchResultKind for the class names.
-  listItem.classList.add(`kind-${kind}`);
   let requestUrl;
   let linkUrl;
   if (docBuilder === "dirhtml") {
@@ -120,10 +115,8 @@ const _finishSearch = (resultCount) => {
       "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 = Documentation.ngettext(
-      "Search finished, found one page matching the search query.",
-      "Search finished, found ${resultCount} pages matching the search query.",
-      resultCount,
+    Search.status.innerText = _(
+      "Search finished, found ${resultCount} page(s) matching the search query."
     ).replace('${resultCount}', resultCount);
 };
 const _displayNextItem = (
@@ -145,7 +138,7 @@ const _displayNextItem = (
   else _finishSearch(resultCount);
 };
 // Helper function used by query() to order search results.
-// Each input is an array of [docname, title, anchor, descr, score, filename, kind].
+// Each input is an array of [docname, title, anchor, descr, score, filename].
 // Order the results by score (in opposite order of appearance, since the
 // `_displayNextItem` function uses pop() to retrieve items) and then alphabetically.
 const _orderResultsByScoreThenName = (a, b) => {
@@ -255,7 +248,6 @@ const Search = {
     searchSummary.classList.add("search-summary");
     searchSummary.innerText = "";
     const searchList = document.createElement("ul");
-    searchList.setAttribute("role", "list");
     searchList.classList.add("search");
 
     const out = document.getElementById("search-results");
@@ -326,7 +318,7 @@ const Search = {
     const indexEntries = Search._index.indexentries;
 
     // Collect multiple result groups to be sorted separately and then ordered.
-    // Each is an array of [docname, title, anchor, descr, score, filename, kind].
+    // Each is an array of [docname, title, anchor, descr, score, filename].
     const normalResults = [];
     const nonMainIndexResults = [];
 
@@ -345,7 +337,6 @@ const Search = {
             null,
             score + boost,
             filenames[file],
-            SearchResultKind.title,
           ]);
         }
       }
@@ -363,7 +354,6 @@ const Search = {
             null,
             score,
             filenames[file],
-            SearchResultKind.index,
           ];
           if (isMain) {
             normalResults.push(result);
@@ -485,7 +475,6 @@ const Search = {
         descr,
         score,
         filenames[match[0]],
-        SearchResultKind.object,
       ]);
     };
     Object.keys(objects).forEach((prefix) =>
@@ -513,11 +502,9 @@ const Search = {
     // perform the search on the required terms
     searchTerms.forEach((word) => {
       const files = [];
-      // find documents, if any, containing the query word in their text/title term indices
-      // use Object.hasOwnProperty to avoid mismatching against prototype properties
       const arr = [
-        { files: terms.hasOwnProperty(word) ? terms[word] : undefined, score: Scorer.term },
-        { files: titleTerms.hasOwnProperty(word) ? titleTerms[word] : undefined, score: Scorer.title },
+        { files: terms[word], score: Scorer.term },
+        { files: titleTerms[word], score: Scorer.title },
       ];
       // add support for partial matches
       if (word.length > 2) {
@@ -549,9 +536,8 @@ const Search = {
 
         // set score for the word in each file
         recordFiles.forEach((file) => {
-          if (!scoreMap.has(file)) scoreMap.set(file, new Map());
-          const fileScores = scoreMap.get(file);
-          fileScores.set(word, record.score);
+          if (!scoreMap.has(file)) scoreMap.set(file, {});
+          scoreMap.get(file)[word] = record.score;
         });
       });
 
@@ -590,7 +576,7 @@ const Search = {
         break;
 
       // select one (max) score for the file.
-      const score = Math.max(...wordList.map((w) => scoreMap.get(file).get(w)));
+      const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w]));
       // add result to the result list
       results.push([
         docNames[file],
@@ -599,7 +585,6 @@ const Search = {
         null,
         score,
         filenames[file],
-        SearchResultKind.text,
       ]);
     }
     return results;