Skip to content

Commit

Permalink
Minor docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
Asa Rentschler committed Aug 16, 2024
1 parent bb33f97 commit 4d47b14
Show file tree
Hide file tree
Showing 28 changed files with 75 additions and 26 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Velocity
<h1><img align="center" height="50" src="assets/artwork/icon.drawio.png"> VELOCITY</h1>

## Description
Container build system.
Expand Down
22 changes: 22 additions & 0 deletions assets/artwork/icon.drawio
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<mxfile host="Electron" modified="2024-07-26T21:18:34.735Z" agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/24.6.4 Chrome/124.0.6367.207 Electron/30.0.6 Safari/537.36" etag="TLQrxEuuHEp0Pp51uT0T" version="24.6.4" type="device">
<diagram name="Page-1" id="uTn-evIf6Q-hgHV7F_A3">
<mxGraphModel dx="1688" dy="703" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="UyPC5gKtdMc87XSLSW9K-4" value="" style="html=1;shape=mxgraph.basic.isocube;isoAngle=15;fillColor=#6d8764;fontColor=#ffffff;strokeColor=#3A5431;" vertex="1" parent="1">
<mxGeometry x="260" y="610" width="100" height="60" as="geometry" />
</mxCell>
<mxCell id="UyPC5gKtdMc87XSLSW9K-27" value="" style="html=1;shape=mxgraph.basic.isocube;isoAngle=15;fillColor=#e51400;fontColor=#ffffff;strokeColor=#B20000;" vertex="1" parent="1">
<mxGeometry x="260" y="590" width="100" height="60" as="geometry" />
</mxCell>
<mxCell id="UyPC5gKtdMc87XSLSW9K-28" value="" style="html=1;shape=mxgraph.basic.isocube;isoAngle=15;fillColor=#f0a30a;fontColor=#000000;strokeColor=#BD7000;" vertex="1" parent="1">
<mxGeometry x="260" y="570" width="100" height="60" as="geometry" />
</mxCell>
<mxCell id="UyPC5gKtdMc87XSLSW9K-29" value="" style="html=1;shape=mxgraph.basic.isocube;isoAngle=15;fillColor=#76608a;fontColor=#ffffff;strokeColor=#432D57;" vertex="1" parent="1">
<mxGeometry x="260" y="550" width="100" height="60" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
Binary file added assets/artwork/icon.drawio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file added docs/build/doctrees/index.doctree
Binary file not shown.
Binary file added docs/build/doctrees/reference/build.doctree
Binary file not shown.
Binary file added docs/build/doctrees/reference/index.doctree
Binary file not shown.
Binary file not shown.
Binary file added docs/build/doctrees/reference/vtmp.doctree
Binary file not shown.
Binary file added docs/build/doctrees/starting/basic.doctree
Binary file not shown.
Binary file added docs/build/doctrees/starting/index.doctree
Binary file not shown.
Binary file added docs/build/doctrees/starting/tutorial.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/.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: 96986716801122c9f70ed8b182a94acb
config: 0a1eabe490da9bb3c4034782d390d609
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added docs/build/html/_static/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 4 additions & 3 deletions docs/build/html/_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 docs/build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />


<link rel="shortcut icon" href="_static/icon.png"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand All @@ -26,12 +27,13 @@
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<div class="wy-side-nav-search" style="background: #909d9e" >



<a href="index.html" class="icon icon-home">
Velocity
<img src="_static/icon.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand All @@ -52,7 +54,7 @@
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #909d9e" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Velocity</a>
</nav>
Expand Down
6 changes: 4 additions & 2 deletions docs/build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />


<link rel="shortcut icon" href="_static/icon.png"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand All @@ -28,12 +29,13 @@
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<div class="wy-side-nav-search" style="background: #909d9e" >



<a href="#" class="icon icon-home">
Velocity
<img src="_static/icon.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand All @@ -54,7 +56,7 @@
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #909d9e" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">Velocity</a>
</nav>
Expand Down
6 changes: 4 additions & 2 deletions docs/build/html/reference/build.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />


<link rel="shortcut icon" href="../_static/icon.png"/>
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand All @@ -28,12 +29,13 @@
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<div class="wy-side-nav-search" style="background: #909d9e" >



<a href="../index.html" class="icon icon-home">
Velocity
<img src="../_static/icon.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down Expand Up @@ -67,7 +69,7 @@
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #909d9e" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Velocity</a>
</nav>
Expand Down
6 changes: 4 additions & 2 deletions docs/build/html/reference/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />


<link rel="shortcut icon" href="../_static/icon.png"/>
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand All @@ -29,12 +30,13 @@
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<div class="wy-side-nav-search" style="background: #909d9e" >



<a href="../index.html" class="icon icon-home">
Velocity
<img src="../_static/icon.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand All @@ -60,7 +62,7 @@
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #909d9e" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Velocity</a>
</nav>
Expand Down
6 changes: 4 additions & 2 deletions docs/build/html/reference/specifications.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />


<link rel="shortcut icon" href="../_static/icon.png"/>
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand All @@ -29,12 +30,13 @@
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<div class="wy-side-nav-search" style="background: #909d9e" >



<a href="../index.html" class="icon icon-home">
Velocity
<img src="../_static/icon.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down Expand Up @@ -70,7 +72,7 @@
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #909d9e" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Velocity</a>
</nav>
Expand Down
6 changes: 4 additions & 2 deletions docs/build/html/reference/vtmp.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />


<link rel="shortcut icon" href="../_static/icon.png"/>
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand All @@ -29,12 +30,13 @@
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<div class="wy-side-nav-search" style="background: #909d9e" >



<a href="../index.html" class="icon icon-home">
Velocity
<img src="../_static/icon.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down Expand Up @@ -76,7 +78,7 @@
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #909d9e" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Velocity</a>
</nav>
Expand Down
6 changes: 4 additions & 2 deletions docs/build/html/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />


<link rel="shortcut icon" href="_static/icon.png"/>

<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
Expand All @@ -29,12 +30,13 @@
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<div class="wy-side-nav-search" style="background: #909d9e" >



<a href="index.html" class="icon icon-home">
Velocity
<img src="_static/icon.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="#" method="get">
Expand All @@ -55,7 +57,7 @@
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #909d9e" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Velocity</a>
</nav>
Expand Down
Loading

0 comments on commit 4d47b14

Please sign in to comment.