Skip to content

Commit 94b8cf1

Browse files
DzmitryPihulskiDzmitryPihulski
committed
Final adjustments;
1 parent 7ce8e9c commit 94b8cf1

File tree

10 files changed

+61
-41
lines changed

10 files changed

+61
-41
lines changed

‎docs/_build/html/.doctrees/environment.pickle‎

-465 Bytes
Binary file not shown.

‎docs/_build/html/.doctrees/index.doctree‎

39 Bytes
Binary file not shown.

‎docs/_build/html/_static/basic.css‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -741,6 +741,14 @@ abbr, acronym {
741741
cursor: help;
742742
}
743743

744+
.translated {
745+
background-color: rgba(207, 255, 207, 0.2)
746+
}
747+
748+
.untranslated {
749+
background-color: rgba(255, 207, 207, 0.2)
750+
}
751+
744752
/* -- code displays --------------------------------------------------------- */
745753

746754
pre {
@@ -903,4 +911,4 @@ div.math:hover a.headerlink {
903911
#top-link {
904912
display: none;
905913
}
906-
}
914+
}

‎docs/_build/html/_static/searchtools.js‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -513,11 +513,9 @@ const Search = {
513513
// perform the search on the required terms
514514
searchTerms.forEach((word) => {
515515
const files = [];
516-
// find documents, if any, containing the query word in their text/title term indices
517-
// use Object.hasOwnProperty to avoid mismatching against prototype properties
518516
const arr = [
519-
{ files: terms.hasOwnProperty(word) ? terms[word] : undefined, score: Scorer.term },
520-
{ files: titleTerms.hasOwnProperty(word) ? titleTerms[word] : undefined, score: Scorer.title },
517+
{ files: terms[word], score: Scorer.term },
518+
{ files: titleTerms[word], score: Scorer.title },
521519
];
522520
// add support for partial matches
523521
if (word.length > 2) {
@@ -549,9 +547,8 @@ const Search = {
549547

550548
// set score for the word in each file
551549
recordFiles.forEach((file) => {
552-
if (!scoreMap.has(file)) scoreMap.set(file, new Map());
553-
const fileScores = scoreMap.get(file);
554-
fileScores.set(word, record.score);
550+
if (!scoreMap.has(file)) scoreMap.set(file, {});
551+
scoreMap.get(file)[word] = record.score;
555552
});
556553
});
557554

@@ -590,7 +587,7 @@ const Search = {
590587
break;
591588

592589
// select one (max) score for the file.
593-
const score = Math.max(...wordList.map((w) => scoreMap.get(file).get(w)));
590+
const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w]));
594591
// add result to the result list
595592
results.push([
596593
docNames[file],

‎docs/_build/html/genindex.html‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
77
<title>Index &#8212; LLMSQL 0.2.0 documentation</title>
88
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8e8a900e" />
9-
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=29da98fa" />
9+
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=5c69cfe2" />
1010
<link rel="stylesheet" type="text/css" href="_static/styles/front_page.css?v=e05e6e91" />
1111
<script src="_static/documentation_options.js?v=938c9ccc"></script>
1212
<script src="_static/doctools.js?v=9bcbadda"></script>
1313
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1414
<script src="_static/scripts/front_page.js?v=a59558f4"></script>
1515
<link rel="index" title="Index" href="#" />
16-
<link rel="search" title="Search" href="search.html" />
16+
<link rel="search" title="Search" href="search.html" />
1717
</head><body>
1818
<div class="related" role="navigation" aria-label="Related">
1919
<h3>Navigation</h3>
@@ -22,20 +22,20 @@ <h3>Navigation</h3>
2222
<a href="#" title="General Index"
2323
accesskey="I">index</a></li>
2424
<li class="nav-item nav-item-0"><a href="index.html">LLMSQL 0.2.0 documentation</a> &#187;</li>
25-
<li class="nav-item nav-item-this"><a href="">Index</a></li>
25+
<li class="nav-item nav-item-this"><a href="">Index</a></li>
2626
</ul>
27-
</div>
27+
</div>
2828

2929
<div class="document">
3030
<div class="documentwrapper">
3131
<div class="bodywrapper">
3232
<div class="body" role="main">
33-
33+
3434

3535
<h1 id="index">Index</h1>
3636

3737
<div class="genindex-jumpbox">
38-
38+
3939
</div>
4040

4141

@@ -66,12 +66,12 @@ <h3>Navigation</h3>
6666
<a href="#" title="General Index"
6767
>index</a></li>
6868
<li class="nav-item nav-item-0"><a href="index.html">LLMSQL 0.2.0 documentation</a> &#187;</li>
69-
<li class="nav-item nav-item-this"><a href="">Index</a></li>
69+
<li class="nav-item nav-item-this"><a href="">Index</a></li>
7070
</ul>
7171
</div>
7272
<div class="footer" role="contentinfo">
7373
&#169; Copyright 2025, Dzmitry Pihulski.
74-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
74+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
7575
</div>
7676
</body>
77-
</html>
77+
</html>

‎docs/_build/html/index.html‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ <h2 id="improvements">Key improvements</h2>
6060

6161
<h2 id="documentation">📚 Documentation</h2>
6262
<div class="note-box">
63-
<p><strong>Note:</strong> Documentation pages (installation guide, API reference) are <strong>under construction</strong>. See <strong>Quick Start</strong> below.</p>
63+
<p><strong>Note:</strong> Documentation pages (installation guide, API reference) are <strong>under construction</strong>. <br> See <strong>Quick Start</strong> below or the README files inside the <a href="https://github.com/LLMSQL/llmsql-benchmark/" target="_blank">repo</a>.</p>
6464
</div>
6565

6666
<h2 id="quick-start">⚡ Quick Start</h2>
@@ -131,9 +131,16 @@ <h2 id="links">🔗 Resources</h2>
131131

132132
<h2 id="leaderboard">📊 Leaderboard [in progress]</h2>
133133
<div class="custom-highlight-box">
134-
<p>The official Leaderboard is currently empty and <strong>in progress</strong>. Submit your model results to be the first on the ranking!</p>
134+
<p>
135+
The official Leaderboard is currently empty and <strong>in progress</strong>.
136+
<a href="https://github.com/LLMSQL/llmsql-benchmark/issues" target="_blank">
137+
Submit
138+
</a>
139+
your model results to be the first on the ranking!
140+
</p>
135141
</div>
136142

143+
137144
<h2 id="citation">📄 Citation</h2>
138145
<pre><code>@inproceedings{llmsql_bench,
139146
title={LLMSQL: Upgrading WikiSQL for the LLM Era of Text-to-SQL},
@@ -152,4 +159,4 @@ <h2 id="citation">📄 Citation</h2>
152159
<script src="_static/scripts/front_page.js"></script>
153160

154161
</body>
155-
</html>
162+
</html>

‎docs/_build/html/search.html‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
77
<title>Search &#8212; LLMSQL 0.2.0 documentation</title>
88
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8e8a900e" />
9-
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=29da98fa" />
9+
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=5c69cfe2" />
1010
<link rel="stylesheet" type="text/css" href="_static/styles/front_page.css?v=e05e6e91" />
11-
11+
1212
<script src="_static/documentation_options.js?v=938c9ccc"></script>
1313
<script src="_static/doctools.js?v=9bcbadda"></script>
1414
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
@@ -19,7 +19,7 @@
1919
<link rel="search" title="Search" href="#" />
2020
<script src="searchindex.js" defer="defer"></script>
2121
<meta name="robots" content="noindex" />
22-
22+
2323

2424
</head><body>
2525
<div class="related" role="navigation" aria-label="Related">
@@ -29,17 +29,17 @@ <h3>Navigation</h3>
2929
<a href="genindex.html" title="General Index"
3030
accesskey="I">index</a></li>
3131
<li class="nav-item nav-item-0"><a href="index.html">LLMSQL 0.2.0 documentation</a> &#187;</li>
32-
<li class="nav-item nav-item-this"><a href="">Search</a></li>
32+
<li class="nav-item nav-item-this"><a href="">Search</a></li>
3333
</ul>
34-
</div>
34+
</div>
3535

3636
<div class="document">
3737
<div class="documentwrapper">
3838
<div class="bodywrapper">
3939
<div class="body" role="main">
40-
40+
4141
<h1 id="search-documentation">Search</h1>
42-
42+
4343
<noscript>
4444
<div class="admonition warning">
4545
<p>
@@ -48,23 +48,23 @@ <h1 id="search-documentation">Search</h1>
4848
</p>
4949
</div>
5050
</noscript>
51-
52-
51+
52+
5353
<p>
5454
Searching for multiple words only shows matches that contain
5555
all words.
5656
</p>
57-
58-
57+
58+
5959
<form action="" method="get">
6060
<input type="text" name="q" aria-labelledby="search-documentation" value="" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
6161
<input type="submit" value="search" />
6262
<span id="search-progress" style="padding-left: 10px"></span>
6363
</form>
64-
65-
64+
65+
6666
<div id="search-results"></div>
67-
67+
6868

6969
<div class="clearer"></div>
7070
</div>
@@ -83,12 +83,12 @@ <h3>Navigation</h3>
8383
<a href="genindex.html" title="General Index"
8484
>index</a></li>
8585
<li class="nav-item nav-item-0"><a href="index.html">LLMSQL 0.2.0 documentation</a> &#187;</li>
86-
<li class="nav-item nav-item-this"><a href="">Search</a></li>
86+
<li class="nav-item nav-item-this"><a href="">Search</a></li>
8787
</ul>
8888
</div>
8989
<div class="footer" role="contentinfo">
9090
&#169; Copyright 2025, Dzmitry Pihulski.
91-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
91+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
9292
</div>
9393
</body>
94-
</html>
94+
</html>

‎docs/_build/html/searchindex.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/_templates/index.html‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ <h2 id="improvements">Key improvements</h2>
6060

6161
<h2 id="documentation">📚 Documentation</h2>
6262
<div class="note-box">
63-
<p><strong>Note:</strong> Documentation pages (installation guide, API reference) are <strong>under construction</strong>. See <strong>Quick Start</strong> below.</p>
63+
<p><strong>Note:</strong> Documentation pages (installation guide, API reference) are <strong>under construction</strong>. <br> See <strong>Quick Start</strong> below or the README files inside the <a href="https://github.com/LLMSQL/llmsql-benchmark/" target="_blank">repo</a>.</p>
6464
</div>
6565

6666
<h2 id="quick-start">⚡ Quick Start</h2>
@@ -131,9 +131,16 @@ <h2 id="links">🔗 Resources</h2>
131131

132132
<h2 id="leaderboard">📊 Leaderboard [in progress]</h2>
133133
<div class="custom-highlight-box">
134-
<p>The official Leaderboard is currently empty and <strong>in progress</strong>. Submit your model results to be the first on the ranking!</p>
134+
<p>
135+
The official Leaderboard is currently empty and <strong>in progress</strong>.
136+
<a href="https://github.com/LLMSQL/llmsql-benchmark/issues" target="_blank">
137+
Submit
138+
</a>
139+
your model results to be the first on the ranking!
140+
</p>
135141
</div>
136142

143+
137144
<h2 id="citation">📄 Citation</h2>
138145
<pre><code>@inproceedings{llmsql_bench,
139146
title={LLMSQL: Upgrading WikiSQL for the LLM Era of Text-to-SQL},

‎docs/note.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
To build the docs, use "sphinx-build -b html docs docs/_build/html" from the root folder.

0 commit comments

Comments
 (0)