From be601660a14cc82defb0affa95f88fc56a93c791 Mon Sep 17 00:00:00 2001
From: blink1073
Date: Wed, 24 Apr 2024 17:12:53 +0000
Subject: [PATCH] deploy: 672c4ff716e7e71ca9b7bc4ac207de8e67956893
---
.buildinfo | 2 +-
CodeofConductJupyterDay.html | 2 +-
CodeofConductJupyterDayOrganizer.html | 2 +-
_sources/people.md | 4 +-
_static/basic.css | 2 +-
_static/doctools.js | 2 +-
_static/language_data.js | 4 +-
_static/searchtools.js | 165 +++++++++++-------
bootstrapping_executive_council.html | 2 +-
bootstrapping_subproject_councils.html | 2 +-
charters/DeiCharter.html | 2 +-
charters/DocumentationCharter.html | 2 +-
charters/MediaStrategyCharter.html | 2 +-
communitybuildingworkinggroup.html | 2 +-
conduct/code_of_conduct.html | 2 +-
conduct/enforcement.html | 2 +-
conduct/faq.html | 2 +-
conduct/reporting_events.html | 2 +-
conduct/reporting_online.html | 2 +-
decision_making.html | 2 +-
distinguished_contributors.html | 2 +-
elections/LICENSE.html | 2 +-
elections/README.html | 2 +-
executive_council.html | 2 +-
genindex.html | 2 +-
governance.html | 2 +-
intro.html | 2 +-
linux-proposal.html | 2 +-
...tanding_committees_and_working_groups.html | 2 +-
list_of_subprojects.html | 2 +-
newsubprojects.html | 2 +-
overview.html | 2 +-
papers.html | 2 +-
people.html | 8 +-
projectlicense.html | 2 +-
search.html | 2 +-
searchindex.js | 2 +-
software_steering_council.html | 2 +-
software_subprojects.html | 2 +-
standing_committees_and_working_groups.html | 2 +-
trademarks.html | 2 +-
41 files changed, 150 insertions(+), 105 deletions(-)
diff --git a/.buildinfo b/.buildinfo
index 678b8bc..2cc9be9 100644
--- a/.buildinfo
+++ b/.buildinfo
@@ -1,4 +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: e1126c78547e476bd8e185befb3acb00
+config: 5cb0d37bc65e2481339fde7a11145311
tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/CodeofConductJupyterDay.html b/CodeofConductJupyterDay.html
index b8170ba..e53c908 100644
--- a/CodeofConductJupyterDay.html
+++ b/CodeofConductJupyterDay.html
@@ -42,7 +42,7 @@
-
+
diff --git a/CodeofConductJupyterDayOrganizer.html b/CodeofConductJupyterDayOrganizer.html
index ace3c2b..55fffda 100644
--- a/CodeofConductJupyterDayOrganizer.html
+++ b/CodeofConductJupyterDayOrganizer.html
@@ -42,7 +42,7 @@
-
+
diff --git a/_sources/people.md b/_sources/people.md
index 306f088..353cf3a 100644
--- a/_sources/people.md
+++ b/_sources/people.md
@@ -10,7 +10,7 @@ Alphabetical by first name, names are followed by GitHub usernames.
- Brian Granger, [@ellisonbg](https://github.com/ellisonbg)
- Fernando Perez, [@fperez](https://github.com/fperez)
- Jason Grout, [@jasongrout](https://github.com/jasongrout)
-- Steven Silvester, [@blink1073](https://github.com/blink1073)
+- Zach Sailer, [@Zsailer](https://github.com/zsailer)
## [Software Steering Council](software_steering_council.md)
@@ -22,7 +22,7 @@ Alphabetical by first name, names are followed by GitHub usernames.
| Jupyter Frontends | Jérémy Tuloup | [@jtpio](https://github.com/jtpio) |
| Jupyter Kernels | Johan Mabille | [@johanmabille](https://github.com/johanmabille) |
| Jupyter Security | Rick Wagner | [@rpwagner](https://github.com/rpwagner) |
-| Jupyter Server | Zach Sailer | [@zsailer](https://github.com/zsailer) |
+| Jupyter Server | In Progress | N/A |
| Jupyter Widgets | Sylvain Corlay | [@SylvainCorlay](https://github.com/SylvainCorlay) |
| JupyterHub and Binder | Min Ragan-Kelley | [@minrk](https://github.com/minrk) |
| Voilà | Martin Renou | [@martinRenou](https://github.com/martinRenou) |
diff --git a/_static/basic.css b/_static/basic.css
index e760386..2af6139 100644
--- a/_static/basic.css
+++ b/_static/basic.css
@@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
diff --git a/_static/doctools.js b/_static/doctools.js
index d06a71d..4d67807 100644
--- a/_static/doctools.js
+++ b/_static/doctools.js
@@ -4,7 +4,7 @@
*
* Base JavaScript utilities for all Sphinx HTML documentation.
*
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
diff --git a/_static/language_data.js b/_static/language_data.js
index 250f566..367b8ed 100644
--- a/_static/language_data.js
+++ b/_static/language_data.js
@@ -5,7 +5,7 @@
* 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.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -13,7 +13,7 @@
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 */
+/* Non-minified version is copied as a separate JS file, if available */
/**
* Porter Stemmer
diff --git a/_static/searchtools.js b/_static/searchtools.js
index 7918c3f..92da3f8 100644
--- a/_static/searchtools.js
+++ b/_static/searchtools.js
@@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for the full-text search.
*
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -99,7 +99,7 @@ const _displayItem = (item, searchTerms, highlightTerms) => {
.then((data) => {
if (data)
listItem.appendChild(
- Search.makeSearchSummary(data, searchTerms)
+ Search.makeSearchSummary(data, searchTerms, anchor)
);
// highlight search terms in the summary
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
@@ -116,8 +116,8 @@ const _finishSearch = (resultCount) => {
);
else
Search.status.innerText = _(
- `Search finished, found ${resultCount} page(s) matching the search query.`
- );
+ "Search finished, found ${resultCount} page(s) matching the search query."
+ ).replace('${resultCount}', resultCount);
};
const _displayNextItem = (
results,
@@ -137,6 +137,22 @@ const _displayNextItem = (
// search finished, update title and status message
else _finishSearch(resultCount);
};
+// Helper function used by query() to order search results.
+// 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) => {
+ 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;
+};
/**
* Default splitQuery function. Can be overridden in ``sphinx.search`` with a
@@ -160,13 +176,26 @@ const Search = {
_queued_query: null,
_pulse_status: -1,
- htmlToText: (htmlString) => {
+ htmlToText: (htmlString, anchor) => {
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
- htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() });
+ for (const removalQuery of [".headerlinks", "script", "style"]) {
+ htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
+ }
+ if (anchor) {
+ const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`);
+ if (anchorContent) return anchorContent.textContent;
+
+ console.warn(
+ `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.`
+ );
+ }
+
+ // if anchor not specified or not found, fall back to main content
const docContent = htmlElement.querySelector('[role="main"]');
- if (docContent !== undefined) return docContent.textContent;
+ if (docContent) 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."
+ "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template."
);
return "";
},
@@ -239,16 +268,7 @@ const Search = {
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;
-
+ _parseQuery: (query) => {
// stem the search terms and add them to the correct list
const stemmer = new Stemmer();
const searchTerms = new Set();
@@ -284,16 +304,32 @@ const Search = {
// console.info("required: ", [...searchTerms]);
// console.info("excluded: ", [...excludedTerms]);
- // array of [docname, title, anchor, descr, score, filename]
- let results = [];
+ return [query, searchTerms, excludedTerms, highlightTerms, objectTerms];
+ },
+
+ /**
+ * execute search (requires search index to be loaded)
+ */
+ _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => {
+ 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;
+
+ // Collect multiple result groups to be sorted separately and then ordered.
+ // Each is an array of [docname, title, anchor, descr, score, filename].
+ const normalResults = [];
+ const nonMainIndexResults = [];
+
_removeChildren(document.getElementById("search-progress"));
- const queryLower = query.toLowerCase();
+ const queryLower = query.toLowerCase().trim();
for (const [title, foundTitles] of Object.entries(allTitles)) {
- if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) {
+ if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
for (const [file, id] of foundTitles) {
let score = Math.round(100 * queryLower.length / title.length)
- results.push([
+ normalResults.push([
docNames[file],
titles[file] !== title ? `${titles[file]} > ${title}` : title,
id !== null ? "#" + id : "",
@@ -308,46 +344,47 @@ const Search = {
// 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([
+ for (const [file, id, isMain] of foundEntries) {
+ const score = Math.round(100 * queryLower.length / entry.length);
+ const result = [
docNames[file],
titles[file],
id ? "#" + id : "",
null,
score,
filenames[file],
- ]);
+ ];
+ if (isMain) {
+ normalResults.push(result);
+ } else {
+ nonMainIndexResults.push(result);
+ }
}
}
}
// lookup as object
objectTerms.forEach((term) =>
- results.push(...Search.performObjectSearch(term, objectTerms))
+ normalResults.push(...Search.performObjectSearch(term, objectTerms))
);
// lookup as search terms in fulltext
- results.push(...Search.performTermsSearch(searchTerms, excludedTerms));
+ normalResults.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;
- });
+ if (Scorer.score) {
+ normalResults.forEach((item) => (item[4] = Scorer.score(item)));
+ nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item)));
+ }
+
+ // Sort each group of results by score and then alphabetically by name.
+ normalResults.sort(_orderResultsByScoreThenName);
+ nonMainIndexResults.sort(_orderResultsByScoreThenName);
+
+ // Combine the result groups in (reverse) order.
+ // Non-main index entries are typically arbitrary cross-references,
+ // so display them after other results.
+ let results = [...nonMainIndexResults, ...normalResults];
// remove duplicate search results
// note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
@@ -361,7 +398,12 @@ const Search = {
return acc;
}, []);
- results = results.reverse();
+ return results.reverse();
+ },
+
+ query: (query) => {
+ const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query);
+ const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms);
// for debugging
//Search.lastresults = results.slice(); // a copy
@@ -466,14 +508,18 @@ const Search = {
// 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 });
- });
+ if (!terms.hasOwnProperty(word)) {
+ Object.keys(terms).forEach((term) => {
+ if (term.match(escapedWord))
+ arr.push({ files: terms[term], score: Scorer.partialTerm });
+ });
+ }
+ if (!titleTerms.hasOwnProperty(word)) {
+ Object.keys(titleTerms).forEach((term) => {
+ if (term.match(escapedWord))
+ arr.push({ files: titleTerms[term], score: Scorer.partialTitle });
+ });
+ }
}
// no match but word was a required one
@@ -496,9 +542,8 @@ const Search = {
// 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]);
+ if (!fileMap.has(file)) fileMap.set(file, [word]);
+ else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word);
});
});
@@ -549,8 +594,8 @@ const Search = {
* search summary for a given text. keywords is a list
* of stemmed words.
*/
- makeSearchSummary: (htmlText, keywords) => {
- const text = Search.htmlToText(htmlText);
+ makeSearchSummary: (htmlText, keywords, anchor) => {
+ const text = Search.htmlToText(htmlText, anchor);
if (text === "") return null;
const textLower = text.toLowerCase();
diff --git a/bootstrapping_executive_council.html b/bootstrapping_executive_council.html
index 72fc5a3..36cc032 100644
--- a/bootstrapping_executive_council.html
+++ b/bootstrapping_executive_council.html
@@ -42,7 +42,7 @@
-
+
diff --git a/bootstrapping_subproject_councils.html b/bootstrapping_subproject_councils.html
index a461956..47ee813 100644
--- a/bootstrapping_subproject_councils.html
+++ b/bootstrapping_subproject_councils.html
@@ -42,7 +42,7 @@
-
+
diff --git a/charters/DeiCharter.html b/charters/DeiCharter.html
index 0e6f0e8..f2449de 100644
--- a/charters/DeiCharter.html
+++ b/charters/DeiCharter.html
@@ -42,7 +42,7 @@
-
+
diff --git a/charters/DocumentationCharter.html b/charters/DocumentationCharter.html
index ae28d32..f20b904 100644
--- a/charters/DocumentationCharter.html
+++ b/charters/DocumentationCharter.html
@@ -42,7 +42,7 @@
-
+
diff --git a/charters/MediaStrategyCharter.html b/charters/MediaStrategyCharter.html
index afa2e49..eb23035 100644
--- a/charters/MediaStrategyCharter.html
+++ b/charters/MediaStrategyCharter.html
@@ -42,7 +42,7 @@
-
+
diff --git a/communitybuildingworkinggroup.html b/communitybuildingworkinggroup.html
index c7d037c..a62e279 100644
--- a/communitybuildingworkinggroup.html
+++ b/communitybuildingworkinggroup.html
@@ -42,7 +42,7 @@
-
+
diff --git a/conduct/code_of_conduct.html b/conduct/code_of_conduct.html
index 5471cac..3e60c22 100644
--- a/conduct/code_of_conduct.html
+++ b/conduct/code_of_conduct.html
@@ -42,7 +42,7 @@
-
+
diff --git a/conduct/enforcement.html b/conduct/enforcement.html
index c25b54d..0ccdb2f 100644
--- a/conduct/enforcement.html
+++ b/conduct/enforcement.html
@@ -42,7 +42,7 @@
-
+
diff --git a/conduct/faq.html b/conduct/faq.html
index 7ae8eb1..2eb7c7d 100644
--- a/conduct/faq.html
+++ b/conduct/faq.html
@@ -42,7 +42,7 @@
-
+
diff --git a/conduct/reporting_events.html b/conduct/reporting_events.html
index 7d401b0..fd34744 100644
--- a/conduct/reporting_events.html
+++ b/conduct/reporting_events.html
@@ -42,7 +42,7 @@
-
+
diff --git a/conduct/reporting_online.html b/conduct/reporting_online.html
index 5a34151..e8026d6 100644
--- a/conduct/reporting_online.html
+++ b/conduct/reporting_online.html
@@ -42,7 +42,7 @@
-
+
diff --git a/decision_making.html b/decision_making.html
index 540a376..9fc0d49 100644
--- a/decision_making.html
+++ b/decision_making.html
@@ -42,7 +42,7 @@
-
+
diff --git a/distinguished_contributors.html b/distinguished_contributors.html
index 34dd14e..83ad119 100644
--- a/distinguished_contributors.html
+++ b/distinguished_contributors.html
@@ -42,7 +42,7 @@
-
+
diff --git a/elections/LICENSE.html b/elections/LICENSE.html
index 1203602..8082626 100644
--- a/elections/LICENSE.html
+++ b/elections/LICENSE.html
@@ -42,7 +42,7 @@
-
+
diff --git a/elections/README.html b/elections/README.html
index 34d01c0..d06ca6d 100644
--- a/elections/README.html
+++ b/elections/README.html
@@ -42,7 +42,7 @@
-
+
diff --git a/executive_council.html b/executive_council.html
index a86e440..ac458b2 100644
--- a/executive_council.html
+++ b/executive_council.html
@@ -42,7 +42,7 @@
-
+
diff --git a/genindex.html b/genindex.html
index 3ff8611..25fcd00 100644
--- a/genindex.html
+++ b/genindex.html
@@ -41,7 +41,7 @@
-
+
diff --git a/governance.html b/governance.html
index d6f1a83..8070507 100644
--- a/governance.html
+++ b/governance.html
@@ -42,7 +42,7 @@
-
+
diff --git a/intro.html b/intro.html
index c5323b7..afb22be 100644
--- a/intro.html
+++ b/intro.html
@@ -42,7 +42,7 @@
-
+
diff --git a/linux-proposal.html b/linux-proposal.html
index bdcd3b0..591d606 100644
--- a/linux-proposal.html
+++ b/linux-proposal.html
@@ -42,7 +42,7 @@
-
+
diff --git a/list_of_standing_committees_and_working_groups.html b/list_of_standing_committees_and_working_groups.html
index 9cc3bb8..5107307 100644
--- a/list_of_standing_committees_and_working_groups.html
+++ b/list_of_standing_committees_and_working_groups.html
@@ -42,7 +42,7 @@
-
+
diff --git a/list_of_subprojects.html b/list_of_subprojects.html
index 20c113d..7818265 100644
--- a/list_of_subprojects.html
+++ b/list_of_subprojects.html
@@ -42,7 +42,7 @@
-
+
diff --git a/newsubprojects.html b/newsubprojects.html
index 71936bd..1071cfe 100644
--- a/newsubprojects.html
+++ b/newsubprojects.html
@@ -42,7 +42,7 @@
-
+
diff --git a/overview.html b/overview.html
index 8ac65f4..acb582c 100644
--- a/overview.html
+++ b/overview.html
@@ -42,7 +42,7 @@
-
+
diff --git a/papers.html b/papers.html
index 706b73b..b0e7ff5 100644
--- a/papers.html
+++ b/papers.html
@@ -42,7 +42,7 @@
-
+
diff --git a/people.html b/people.html
index ac368c0..fedd208 100644
--- a/people.html
+++ b/people.html
@@ -42,7 +42,7 @@
-
+
@@ -409,7 +409,7 @@
Fernando Perez, @fperez
Jason Grout, @jasongrout
-Steven Silvester, @blink1073
+Zach Sailer, @Zsailer