diff --git a/.buildinfo b/.buildinfo
index b74170e..5ff3774 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: ba2586901e2fdc843ceba61cf00da0a2
+config: c1cb09409ecc2738580dc944b34f8f2c
tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_sources/getting_started.rst.txt b/_sources/getting_started.rst.txt
index 4717a99..98d26c6 100644
--- a/_sources/getting_started.rst.txt
+++ b/_sources/getting_started.rst.txt
@@ -8,7 +8,7 @@ Repo file structure
| * `ISSUE_TEMPLATE` has files that are templates users can select from when opening an issue in the repo on GitHub
| * `workflows` implements continuous integration (CI) through GitHub 'actions' that are automatically run according to a chosen trigger. These are currently:
| - `docs.yml` builds and deploys this docs site when a push is made to `main`.
-| - `format_lint.yml` lints and formats the code on each push using *ruff* and *black*.
+| - `format_lint.yml` lints and formats the code on each push using *ruff*.
| - `package.yml` releases the package to PyPI on each *release* (create a release from the repo's main GitHub page). This makes the latest release version of the package *pip*-installable. For a guide on how to first reserve a name for your project on PyPI (necessary for this workflow), see the `Python packaging guide `_.
| - `tests.yml` runs tests with *pytest* on each push.
| - `type_check.yml` runs type checking with *mypy* on each push. The CI continues even if the type checker finds errors.
@@ -38,7 +38,7 @@ Interacting with your new code
| 2) Run your tests:
| `pytest .`
| 3) Run linting and formatting to see their effects:
-| `black .` and `ruff check .`
+| `ruff check .`
| 4) Run type checking using mypy:
| `mypy --strict .`
| 5) Build your docs locally:
diff --git a/_static/searchtools.js b/_static/searchtools.js
index 92da3f8..b08d58c 100644
--- a/_static/searchtools.js
+++ b/_static/searchtools.js
@@ -178,7 +178,7 @@ const Search = {
htmlToText: (htmlString, anchor) => {
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
- for (const removalQuery of [".headerlinks", "script", "style"]) {
+ for (const removalQuery of [".headerlink", "script", "style"]) {
htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
}
if (anchor) {
@@ -328,13 +328,14 @@ const Search = {
for (const [title, foundTitles] of Object.entries(allTitles)) {
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)
+ const score = Math.round(Scorer.title * queryLower.length / title.length);
+ const boost = titles[file] === title ? 1 : 0; // add a boost for document titles
normalResults.push([
docNames[file],
titles[file] !== title ? `${titles[file]} > ${title}` : title,
id !== null ? "#" + id : "",
null,
- score,
+ score + boost,
filenames[file],
]);
}
diff --git a/coverage/class_index.html b/coverage/class_index.html
index faffb1e..6ec3f09 100644
--- a/coverage/class_index.html
+++ b/coverage/class_index.html
@@ -54,8 +54,8 @@