Skip to content

Commit 8f0dff6

Browse files
Regenerate documentation
1 parent ab79582 commit 8f0dff6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+2776
-3391
lines changed

docs/book/404.html

Lines changed: 53 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!DOCTYPE HTML>
2-
<html lang="en" class="light sidebar-visible" dir="ltr">
2+
<html lang="en" class="light" dir="ltr">
33
<head>
44
<!-- Book generated using mdBook -->
55
<meta charset="UTF-8">
@@ -8,7 +8,7 @@
88

99

1010
<!-- Custom HTML head -->
11-
11+
1212
<meta name="description" content="">
1313
<meta name="viewport" content="width=device-width, initial-scale=1">
1414
<meta name="theme-color" content="#ffffff">
@@ -25,41 +25,26 @@
2525
<link rel="stylesheet" href="fonts/fonts.css">
2626

2727
<!-- Highlight.js Stylesheets -->
28-
<link rel="stylesheet" id="highlight-css" href="highlight.css">
29-
<link rel="stylesheet" id="tomorrow-night-css" href="tomorrow-night.css">
30-
<link rel="stylesheet" id="ayu-highlight-css" href="ayu-highlight.css">
28+
<link rel="stylesheet" href="highlight.css">
29+
<link rel="stylesheet" href="tomorrow-night.css">
30+
<link rel="stylesheet" href="ayu-highlight.css">
3131

3232
<!-- Custom theme stylesheets -->
3333

34-
35-
<!-- Provide site root and default themes to javascript -->
36-
<script>
37-
const path_to_root = "";
38-
const default_light_theme = "light";
39-
const default_dark_theme = "navy";
40-
window.path_to_searchindex_js = "searchindex.js";
41-
</script>
42-
<!-- Start loading toc.js asap -->
43-
<script src="toc.js"></script>
4434
</head>
45-
<body>
46-
<div id="mdbook-help-container">
47-
<div id="mdbook-help-popup">
48-
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
49-
<div>
50-
<p>Press <kbd></kbd> or <kbd></kbd> to navigate between chapters</p>
51-
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
52-
<p>Press <kbd>?</kbd> to show this help</p>
53-
<p>Press <kbd>Esc</kbd> to hide this help</p>
54-
</div>
55-
</div>
56-
</div>
35+
<body class="sidebar-visible no-js">
5736
<div id="body-container">
37+
<!-- Provide site root to javascript -->
38+
<script>
39+
var path_to_root = "";
40+
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
41+
</script>
42+
5843
<!-- Work around some values being stored in localStorage wrapped in quotes -->
5944
<script>
6045
try {
61-
let theme = localStorage.getItem('mdbook-theme');
62-
let sidebar = localStorage.getItem('mdbook-sidebar');
46+
var theme = localStorage.getItem('mdbook-theme');
47+
var sidebar = localStorage.getItem('mdbook-sidebar');
6348

6449
if (theme.startsWith('"') && theme.endsWith('"')) {
6550
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
@@ -73,51 +58,70 @@ <h2 class="mdbook-help-title">Keyboard shortcuts</h2>
7358

7459
<!-- Set the theme before any content is loaded, prevents flash -->
7560
<script>
76-
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
77-
let theme;
61+
var theme;
7862
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
7963
if (theme === null || theme === undefined) { theme = default_theme; }
80-
const html = document.documentElement;
64+
var html = document.querySelector('html');
8165
html.classList.remove('light')
8266
html.classList.add(theme);
83-
html.classList.add("js");
67+
var body = document.querySelector('body');
68+
body.classList.remove('no-js')
69+
body.classList.add('js');
8470
</script>
8571

8672
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
8773

8874
<!-- Hide / unhide sidebar before it is displayed -->
8975
<script>
90-
let sidebar = null;
91-
const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
76+
var body = document.querySelector('body');
77+
var sidebar = null;
78+
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
9279
if (document.body.clientWidth >= 1080) {
9380
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
9481
sidebar = sidebar || 'visible';
9582
} else {
9683
sidebar = 'hidden';
97-
sidebar_toggle.checked = false;
98-
}
99-
if (sidebar === 'visible') {
100-
sidebar_toggle.checked = true;
101-
} else {
102-
html.classList.remove('sidebar-visible');
10384
}
85+
sidebar_toggle.checked = sidebar === 'visible';
86+
body.classList.remove('sidebar-visible');
87+
body.classList.add("sidebar-" + sidebar);
10488
</script>
10589

10690
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
107-
<!-- populated by js -->
108-
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
109-
<noscript>
110-
<iframe class="sidebar-iframe-outer" src="toc.html"></iframe>
111-
</noscript>
91+
<div class="sidebar-scrollbox">
92+
<ol class="chapter"><li class="chapter-item expanded affix "><a href="introduction.html">Introduction</a></li><li class="chapter-item expanded affix "><li class="part-title">User Guide</li><li class="chapter-item expanded "><a href="guide/requirements.html"><strong aria-hidden="true">1.</strong> Requirements</a></li><li class="chapter-item expanded "><a href="guide/installation.html"><strong aria-hidden="true">2.</strong> Installation</a></li><li class="chapter-item expanded "><a href="guide/indexing-pipeline.html"><strong aria-hidden="true">3.</strong> Indexing Pipeline</a></li><li class="chapter-item expanded "><a href="guide/parsing.html"><strong aria-hidden="true">4.</strong> Parsing</a></li><li class="chapter-item expanded "><a href="guide/inverting.html"><strong aria-hidden="true">5.</strong> Inverting</a></li><li class="chapter-item expanded "><a href="guide/compressing.html"><strong aria-hidden="true">6.</strong> Compressing</a></li><li class="chapter-item expanded "><a href="guide/wand_data.html"><strong aria-hidden="true">7.</strong> "WAND" Data</a></li><li class="chapter-item expanded "><a href="guide/querying.html"><strong aria-hidden="true">8.</strong> Querying</a></li><li class="chapter-item expanded "><a href="guide/algorithms.html"><strong aria-hidden="true">9.</strong> Retrieval Algorithms</a></li><li class="chapter-item expanded "><a href="guide/reordering.html"><strong aria-hidden="true">10.</strong> Document Reordering</a></li><li class="chapter-item expanded "><a href="guide/sharding.html"><strong aria-hidden="true">11.</strong> Sharding</a></li><li class="chapter-item expanded "><a href="guide/threshold-estimation.html"><strong aria-hidden="true">12.</strong> Threshold Estimation</a></li><li class="chapter-item expanded affix "><li class="part-title">Tutorials</li><li class="chapter-item expanded "><a href="tutorial/robust04.html"><strong aria-hidden="true">13.</strong> Regression test for Robust04</a></li><li class="chapter-item expanded affix "><li class="part-title">CLI Reference</li><li class="chapter-item expanded "><a href="cli/compress_inverted_index.html"><strong aria-hidden="true">14.</strong> compress_inverted_index</a></li><li class="chapter-item expanded "><a href="cli/compute_intersection.html"><strong aria-hidden="true">15.</strong> compute_intersection</a></li><li class="chapter-item expanded "><a href="cli/count-postings.html"><strong aria-hidden="true">16.</strong> count-postings</a></li><li class="chapter-item expanded "><a href="cli/create_wand_data.html"><strong aria-hidden="true">17.</strong> create_wand_data</a></li><li class="chapter-item expanded "><a href="cli/evaluate_queries.html"><strong aria-hidden="true">18.</strong> evaluate_queries</a></li><li class="chapter-item expanded "><a href="cli/extract-maxscores.html"><strong aria-hidden="true">19.</strong> extract-maxscores</a></li><li class="chapter-item expanded "><a href="cli/extract_topics.html"><strong aria-hidden="true">20.</strong> extract_topics</a></li><li class="chapter-item expanded "><a href="cli/invert.html"><strong aria-hidden="true">21.</strong> invert</a></li><li class="chapter-item expanded "><a href="cli/kth_threshold.html"><strong aria-hidden="true">22.</strong> kth_threshold</a></li><li class="chapter-item expanded "><a href="cli/lexicon.html"><strong aria-hidden="true">23.</strong> lexicon</a></li><li class="chapter-item expanded "><a href="cli/map_queries.html"><strong aria-hidden="true">24.</strong> map_queries</a></li><li class="chapter-item expanded "><a href="cli/parse_collection.html"><strong aria-hidden="true">25.</strong> parse_collection</a></li><li class="chapter-item expanded "><a href="cli/partition_fwd_index.html"><strong aria-hidden="true">26.</strong> partition_fwd_index</a></li><li class="chapter-item expanded "><a href="cli/queries.html"><strong aria-hidden="true">27.</strong> queries</a></li><li class="chapter-item expanded "><a href="cli/read_collection.html"><strong aria-hidden="true">28.</strong> read_collection</a></li><li class="chapter-item expanded "><a href="cli/reorder-docids.html"><strong aria-hidden="true">29.</strong> reorder-docids</a></li><li class="chapter-item expanded "><a href="cli/sample_inverted_index.html"><strong aria-hidden="true">30.</strong> sample_inverted_index</a></li><li class="chapter-item expanded "><a href="cli/selective_queries.html"><strong aria-hidden="true">31.</strong> selective_queries</a></li><li class="chapter-item expanded "><a href="cli/shards.html"><strong aria-hidden="true">32.</strong> shards</a></li><li class="chapter-item expanded "><a href="cli/stem_queries.html"><strong aria-hidden="true">33.</strong> stem_queries</a></li><li class="chapter-item expanded "><a href="cli/taily-stats.html"><strong aria-hidden="true">34.</strong> taily-stats</a></li><li class="chapter-item expanded "><a href="cli/taily-thresholds.html"><strong aria-hidden="true">35.</strong> taily-thresholds</a></li><li class="chapter-item expanded "><a href="cli/thresholds.html"><strong aria-hidden="true">36.</strong> thresholds</a></li><li class="chapter-item expanded affix "><li class="part-title">Specifications</li><li class="chapter-item expanded "><a href="specs/lookup-table.html"><strong aria-hidden="true">37.</strong> Lookup Table</a></li></ol>
93+
</div>
11294
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
11395
<div class="sidebar-resize-indicator"></div>
11496
</div>
11597
</nav>
11698

99+
<!-- Track and set sidebar scroll position -->
100+
<script>
101+
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
102+
sidebarScrollbox.addEventListener('click', function(e) {
103+
if (e.target.tagName === 'A') {
104+
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
105+
}
106+
}, { passive: true });
107+
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
108+
sessionStorage.removeItem('sidebar-scroll');
109+
if (sidebarScrollTop) {
110+
// preserve sidebar scroll position when navigating via links within sidebar
111+
sidebarScrollbox.scrollTop = sidebarScrollTop;
112+
} else {
113+
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
114+
var activeSection = document.querySelector('#sidebar .active');
115+
if (activeSection) {
116+
activeSection.scrollIntoView({ block: 'center' });
117+
}
118+
}
119+
</script>
120+
117121
<div id="page-wrapper" class="page-wrapper">
118122

119123
<div class="page">
120-
<div id="menu-bar-hover-placeholder"></div>
124+
<div id="menu-bar-hover-placeholder"></div>
121125
<div id="menu-bar" class="menu-bar sticky">
122126
<div class="left-buttons">
123127
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
@@ -127,14 +131,13 @@ <h2 class="mdbook-help-title">Keyboard shortcuts</h2>
127131
<i class="fa fa-paint-brush"></i>
128132
</button>
129133
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
130-
<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
131134
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
132135
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
133136
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
134137
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
135138
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
136139
</ul>
137-
<button id="search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="searchbar">
140+
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
138141
<i class="fa fa-search"></i>
139142
</button>
140143
</div>
@@ -151,12 +154,7 @@ <h1 class="menu-title">PISA Guide</h1>
151154

152155
<div id="search-wrapper" class="hidden">
153156
<form id="searchbar-outer" class="searchbar-outer">
154-
<div class="search-wrapper">
155-
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
156-
<div class="spinner-wrapper">
157-
<i class="fa fa-spinner fa-spin"></i>
158-
</div>
159-
</div>
157+
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
160158
</form>
161159
<div id="searchresults-outer" class="searchresults-outer hidden">
162160
<div id="searchresults-header" class="searchresults-header"></div>
@@ -215,7 +213,6 @@ <h1 id="document-not-found-404"><a class="header" href="#document-not-found-404"
215213
<!-- Custom JS scripts -->
216214

217215

218-
219216
</div>
220217
</body>
221218
</html>

0 commit comments

Comments
 (0)