Skip to content

Commit

Permalink
Migrate to mdBook documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@elshize
elshize committed Oct 9, 2023
1 parent 653e225 commit 5068e99
Show file tree
Hide file tree
Showing 119 changed files with 16,800 additions and 709 deletions.
22 changes: 5 additions & 17 deletions docs/Makefile
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,7 @@
# Minimal makefile for Sphinx documentation
#
all:
mdbook build .

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = source
BUILDDIR = _build
clean:
mdbook clean .

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: clean
22 changes: 22 additions & 0 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Generating Documentation

## Requirements

* `make`
* `mdbook`
* `mdbook-cmdrun`

Install mdBook and cmdrun plugin with:

```
cargo install mdbook
cargo install mdbook-cmdrun
```

## Generate

Generate by calling the following _in this directory_:

```
make
```
8 changes: 8 additions & 0 deletions docs/book.toml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[book]
authors = ["Michal Siedlaczek"]
language = "en"
multilingual = false
src = "src"
title = "PISA Guide"

[preprocessor.cmdrun]
1 change: 1 addition & 0 deletions docs/book/.nojekyll
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This file makes sure that Github Pages doesn't process mdBook's output.
216 changes: 216 additions & 0 deletions docs/book/404.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,216 @@
<!DOCTYPE HTML>
<html lang="en" class="light" dir="ltr">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>Page not found - PISA Guide</title>
<base href="/">


<!-- Custom HTML head -->

<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff">

<link rel="icon" href="favicon.svg">
<link rel="shortcut icon" href="favicon.png">
<link rel="stylesheet" href="css/variables.css">
<link rel="stylesheet" href="css/general.css">
<link rel="stylesheet" href="css/chrome.css">
<link rel="stylesheet" href="css/print.css" media="print">

<!-- Fonts -->
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="fonts/fonts.css">

<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" href="highlight.css">
<link rel="stylesheet" href="tomorrow-night.css">
<link rel="stylesheet" href="ayu-highlight.css">

<!-- Custom theme stylesheets -->

</head>
<body class="sidebar-visible no-js">
<div id="body-container">
<!-- Provide site root to javascript -->
<script>
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
</script>

<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script>
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');

if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}

if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>

<!-- Set the theme before any content is loaded, prevents flash -->
<script>
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('light')
html.classList.add(theme);
var body = document.querySelector('body');
body.classList.remove('no-js')
body.classList.add('js');
</script>

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

<!-- Hide / unhide sidebar before it is displayed -->
<script>
var body = document.querySelector('body');
var sidebar = null;
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
}
sidebar_toggle.checked = sidebar === 'visible';
body.classList.remove('sidebar-visible');
body.classList.add("sidebar-" + sidebar);
</script>

<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<div class="sidebar-scrollbox">
<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/querying.html"><strong aria-hidden="true">7.</strong> Querying</a></li><li class="chapter-item expanded "><a href="guide/reordering.html"><strong aria-hidden="true">8.</strong> Document Reordering</a></li><li class="chapter-item expanded "><a href="guide/sharding.html"><strong aria-hidden="true">9.</strong> Sharding</a></li><li class="chapter-item expanded "><a href="guide/threshold-estimation.html"><strong aria-hidden="true">10.</strong> Threshold Estimation</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">11.</strong> compress_inverted_index</a></li><li class="chapter-item expanded "><a href="cli/compute_intersection.html"><strong aria-hidden="true">12.</strong> compute_intersection</a></li><li class="chapter-item expanded "><a href="cli/count-postings.html"><strong aria-hidden="true">13.</strong> count-postings</a></li><li class="chapter-item expanded "><a href="cli/create_wand_data.html"><strong aria-hidden="true">14.</strong> create_wand_data</a></li><li class="chapter-item expanded "><a href="cli/evaluate_queries.html"><strong aria-hidden="true">15.</strong> evaluate_queries</a></li><li class="chapter-item expanded "><a href="cli/extract-maxscores.html"><strong aria-hidden="true">16.</strong> extract-maxscores</a></li><li class="chapter-item expanded "><a href="cli/extract_topics.html"><strong aria-hidden="true">17.</strong> extract_topics</a></li><li class="chapter-item expanded "><a href="cli/invert.html"><strong aria-hidden="true">18.</strong> invert</a></li><li class="chapter-item expanded "><a href="cli/kth_threshold.html"><strong aria-hidden="true">19.</strong> kth_threshold</a></li><li class="chapter-item expanded "><a href="cli/lexicon.html"><strong aria-hidden="true">20.</strong> lexicon</a></li><li class="chapter-item expanded "><a href="cli/map_queries.html"><strong aria-hidden="true">21.</strong> map_queries</a></li><li class="chapter-item expanded "><a href="cli/parse_collection.html"><strong aria-hidden="true">22.</strong> parse_collection</a></li><li class="chapter-item expanded "><a href="cli/partition_fwd_index.html"><strong aria-hidden="true">23.</strong> partition_fwd_index</a></li><li class="chapter-item expanded "><a href="cli/queries.html"><strong aria-hidden="true">24.</strong> queries</a></li><li class="chapter-item expanded "><a href="cli/read_collection.html"><strong aria-hidden="true">25.</strong> read_collection</a></li><li class="chapter-item expanded "><a href="cli/reorder-docids.html"><strong aria-hidden="true">26.</strong> reorder-docids</a></li><li class="chapter-item expanded "><a href="cli/sample_inverted_index.html"><strong aria-hidden="true">27.</strong> sample_inverted_index</a></li><li class="chapter-item expanded "><a href="cli/selective_queries.html"><strong aria-hidden="true">28.</strong> selective_queries</a></li><li class="chapter-item expanded "><a href="cli/shards.html"><strong aria-hidden="true">29.</strong> shards</a></li><li class="chapter-item expanded "><a href="cli/stem_queries.html"><strong aria-hidden="true">30.</strong> stem_queries</a></li><li class="chapter-item expanded "><a href="cli/taily-stats.html"><strong aria-hidden="true">31.</strong> taily-stats</a></li><li class="chapter-item expanded "><a href="cli/taily-thresholds.html"><strong aria-hidden="true">32.</strong> taily-thresholds</a></li><li class="chapter-item expanded "><a href="cli/thresholds.html"><strong aria-hidden="true">33.</strong> thresholds</a></li></ol>
</div>
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
</nav>

<!-- Track and set sidebar scroll position -->
<script>
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
sidebarScrollbox.addEventListener('click', function(e) {
if (e.target.tagName === 'A') {
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
}
}, { passive: true });
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
sessionStorage.removeItem('sidebar-scroll');
if (sidebarScrollTop) {
// preserve sidebar scroll position when navigating via links within sidebar
sidebarScrollbox.scrollTop = sidebarScrollTop;
} else {
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
var activeSection = document.querySelector('#sidebar .active');
if (activeSection) {
activeSection.scrollIntoView({ block: 'center' });
}
}
</script>

<div id="page-wrapper" class="page-wrapper">

<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky">
<div class="left-buttons">
<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">
<i class="fa fa-bars"></i>
</label>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<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">
<i class="fa fa-search"></i>
</button>
</div>

<h1 class="menu-title">PISA Guide</h1>

<div class="right-buttons">
<a href="print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>

</div>
</div>

<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>

<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script>
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>

<div id="content" class="content">
<main>
<h1 id="document-not-found-404"><a class="header" href="#document-not-found-404">Document not found (404)</a></h1>
<p>This URL is invalid, sorry. Please use the navigation bar or search to continue.</p>

</main>

<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->


<div style="clear: both"></div>
</nav>
</div>
</div>

<nav class="nav-wide-wrapper" aria-label="Page navigation">

</nav>

</div>




<script>
window.playground_copyable = true;
</script>


<script src="elasticlunr.min.js"></script>
<script src="mark.min.js"></script>
<script src="searcher.js"></script>

<script src="clipboard.min.js"></script>
<script src="highlight.js"></script>
<script src="book.js"></script>

<!-- Custom JS scripts -->


</div>
</body>
</html>
4 changes: 4 additions & 0 deletions docs/book/FontAwesome/css/font-awesome.css
View file

Large diffs are not rendered by default.

Binary file added docs/book/FontAwesome/fonts/FontAwesome.ttf
View file
Binary file not shown.
Binary file added docs/book/FontAwesome/fonts/fontawesome-webfont.eot
View file
Binary file not shown.
Loading

0 comments on commit 5068e99

Please sign in to comment.