Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jul 15, 2024
1 parent d379e60 commit 8992aeb
Show file tree
Hide file tree
Showing 44 changed files with 10 additions and 7 deletions.
2 changes: 1 addition & 1 deletion _build/html/main/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: f60c9a06d21377195daa736a0dce1d71
config: 43c055c0885f3ca6ba2ecd0f3b0faae2
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified _build/html/main/.doctrees/add-new-diagnostics.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/available-parameters.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/colormaps.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/config-run.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/contributing.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/defining-parameters.doctree
Binary file not shown.
Binary file not shown.
Binary file modified _build/html/main/.doctrees/dev_guide/index.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/dev_guide/project-standards.doctree
Binary file not shown.
Binary file not shown.
Binary file modified _build/html/main/.doctrees/dev_guide/testing.doctree
Binary file not shown.
Binary file not shown.
Binary file modified _build/html/main/.doctrees/environment.pickle
Binary file not shown.
Binary file modified _build/html/main/.doctrees/examples.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/index.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/input-data-requirement.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/install.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/quickguides/index.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/quickguides/old/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified _build/html/main/.doctrees/quickguides/quick-guide-acme1.doctree
Binary file not shown.
Binary file modified _build/html/main/.doctrees/quickguides/quick-guide-anvil.doctree
Binary file not shown.
Binary file not shown.
Binary file modified _build/html/main/.doctrees/quickguides/quick-guide-compy.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
7 changes: 4 additions & 3 deletions _build/html/main/_static/searchtools.js
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down Expand Up @@ -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],
]);
}
Expand Down
6 changes: 4 additions & 2 deletions _build/html/main/dev_guide/project-standards.html
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,8 @@ <h2>Development Environment<a class="headerlink" href="#development-environment"
<h2>Version Control<a class="headerlink" href="#version-control" title="Link to this heading"></a></h2>
<p>The repository uses a fork-based Git workflow with tag releases.</p>
<figure class="align-default">
<img alt="Git Flow Diagram" src="../_images/git-flow.svg" /></figure>
<img alt="Git Flow Diagram" src="../_images/git-flow.svg" />
</figure>
<section id="guidelines">
<h3>Guidelines<a class="headerlink" href="#guidelines" title="Link to this heading"></a></h3>
<ol class="arabic simple">
Expand Down Expand Up @@ -155,7 +156,8 @@ <h3>Pre-commit<a class="headerlink" href="#pre-commit" title="Link to this headi
These hooks help enforce quality assurance standards and identify simple issues
at the commit level before submitting code reviews.</p>
<figure class="align-default" id="id4">
<img alt="Pre-commit Flow Diagram" src="../_images/pre-commit-flow.svg" /><figcaption>
<img alt="Pre-commit Flow Diagram" src="../_images/pre-commit-flow.svg" />
<figcaption>
<p><span class="caption-text"><code class="docutils literal notranslate"><span class="pre">pre-commit</span></code> Flow</span><a class="headerlink" href="#id4" title="Link to this image"></a></p>
</figcaption>
</figure>
Expand Down
2 changes: 1 addition & 1 deletion _build/html/main/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 8992aeb

Please sign in to comment.