Skip to content

Commit 0aa6c70

Browse files
actions-useractions-user
committed
Update docs from rizinorg/cutter
Original Commit: 634a0be6f7d1667f145aa2776c26d52f4154350b Allow loading user compiled plugins. (#3385)
1 parent b7761b7 commit 0aa6c70

File tree

401 files changed

+820
-833
lines changed

Some content is hidden

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

401 files changed

+820
-833
lines changed

‎docs/.buildinfo

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
2-
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 098abf896dd6c79fe9d565be84e43b61
2+
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 453801e608e7b9487ea7f1e185120ab1
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_static/basic.css

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
/*
2-
* basic.css
3-
* ~~~~~~~~~
4-
*
52
* Sphinx stylesheet -- basic theme.
6-
*
7-
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
8-
* :license: BSD, see LICENSE for details.
9-
*
103
*/
114

125
/* -- main layout ----------------------------------------------------------- */
@@ -115,15 +108,11 @@ img {
115108
/* -- search page ----------------------------------------------------------- */
116109

117110
ul.search {
118-
margin: 10px 0 0 20px;
119-
padding: 0;
111+
margin-top: 10px;
120112
}
121113

122114
ul.search li {
123-
padding: 5px 0 5px 20px;
124-
background-image: url(file.png);
125-
background-repeat: no-repeat;
126-
background-position: 0 7px;
115+
padding: 5px 0;
127116
}
128117

129118
ul.search li a {

‎docs/_static/doctools.js

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
/*
2-
* doctools.js
3-
* ~~~~~~~~~~~
4-
*
52
* Base JavaScript utilities for all Sphinx HTML documentation.
6-
*
7-
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
8-
* :license: BSD, see LICENSE for details.
9-
*
103
*/
114
"use strict";
125

‎docs/_static/language_data.js

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
/*
2-
* language_data.js
3-
* ~~~~~~~~~~~~~~~~
4-
*
52
* This script contains the language-specific data used by searchtools.js,
63
* namely the list of stopwords, stemmer, scorer and splitter.
7-
*
8-
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
9-
* :license: BSD, see LICENSE for details.
10-
*
114
*/
125

136
var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];

‎docs/_static/searchtools.js

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
/*
2-
* searchtools.js
3-
* ~~~~~~~~~~~~~~~~
4-
*
52
* Sphinx JavaScript utilities for the full-text search.
6-
*
7-
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
8-
* :license: BSD, see LICENSE for details.
9-
*
103
*/
114
"use strict";
125

@@ -20,7 +13,7 @@ if (typeof Scorer === "undefined") {
2013
// and returns the new score.
2114
/*
2215
score: result => {
23-
const [docname, title, anchor, descr, score, filename] = result
16+
const [docname, title, anchor, descr, score, filename, kind] = result
2417
return score
2518
},
2619
*/
@@ -47,6 +40,14 @@ if (typeof Scorer === "undefined") {
4740
};
4841
}
4942

43+
// Global search result kind enum, used by themes to style search results.
44+
class SearchResultKind {
45+
static get index() { return "index"; }
46+
static get object() { return "object"; }
47+
static get text() { return "text"; }
48+
static get title() { return "title"; }
49+
}
50+
5051
const _removeChildren = (element) => {
5152
while (element && element.lastChild) element.removeChild(element.lastChild);
5253
};
@@ -64,9 +65,13 @@ const _displayItem = (item, searchTerms, highlightTerms) => {
6465
const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
6566
const contentRoot = document.documentElement.dataset.content_root;
6667

67-
const [docName, title, anchor, descr, score, _filename] = item;
68+
const [docName, title, anchor, descr, score, _filename, kind] = item;
6869

6970
let listItem = document.createElement("li");
71+
// Add a class representing the item's type:
72+
// can be used by a theme's CSS selector for styling
73+
// See SearchResultKind for the class names.
74+
listItem.classList.add(`kind-${kind}`);
7075
let requestUrl;
7176
let linkUrl;
7277
if (docBuilder === "dirhtml") {
@@ -115,8 +120,10 @@ const _finishSearch = (resultCount) => {
115120
"Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
116121
);
117122
else
118-
Search.status.innerText = _(
119-
"Search finished, found ${resultCount} page(s) matching the search query."
123+
Search.status.innerText = Documentation.ngettext(
124+
"Search finished, found one page matching the search query.",
125+
"Search finished, found ${resultCount} pages matching the search query.",
126+
resultCount,
120127
).replace('${resultCount}', resultCount);
121128
};
122129
const _displayNextItem = (
@@ -138,7 +145,7 @@ const _displayNextItem = (
138145
else _finishSearch(resultCount);
139146
};
140147
// Helper function used by query() to order search results.
141-
// Each input is an array of [docname, title, anchor, descr, score, filename].
148+
// Each input is an array of [docname, title, anchor, descr, score, filename, kind].
142149
// Order the results by score (in opposite order of appearance, since the
143150
// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically.
144151
const _orderResultsByScoreThenName = (a, b) => {
@@ -248,6 +255,7 @@ const Search = {
248255
searchSummary.classList.add("search-summary");
249256
searchSummary.innerText = "";
250257
const searchList = document.createElement("ul");
258+
searchList.setAttribute("role", "list");
251259
searchList.classList.add("search");
252260

253261
const out = document.getElementById("search-results");
@@ -318,7 +326,7 @@ const Search = {
318326
const indexEntries = Search._index.indexentries;
319327

320328
// Collect multiple result groups to be sorted separately and then ordered.
321-
// Each is an array of [docname, title, anchor, descr, score, filename].
329+
// Each is an array of [docname, title, anchor, descr, score, filename, kind].
322330
const normalResults = [];
323331
const nonMainIndexResults = [];
324332

@@ -337,6 +345,7 @@ const Search = {
337345
null,
338346
score + boost,
339347
filenames[file],
348+
SearchResultKind.title,
340349
]);
341350
}
342351
}
@@ -354,6 +363,7 @@ const Search = {
354363
null,
355364
score,
356365
filenames[file],
366+
SearchResultKind.index,
357367
];
358368
if (isMain) {
359369
normalResults.push(result);
@@ -475,6 +485,7 @@ const Search = {
475485
descr,
476486
score,
477487
filenames[match[0]],
488+
SearchResultKind.object,
478489
]);
479490
};
480491
Object.keys(objects).forEach((prefix) =>
@@ -585,6 +596,7 @@ const Search = {
585596
null,
586597
score,
587598
filenames[file],
599+
SearchResultKind.text,
588600
]);
589601
}
590602
return results;

‎docs/api.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<link rel="stylesheet" type="text/css" href="_static/cutter.css?v=3dc06d89" />
1212
<link rel="stylesheet" type="text/css" href="_static/admonitions.css?v=f99abf92" />
1313
<script src="_static/documentation_options.js?v=4d935f96"></script>
14-
<script src="_static/doctools.js?v=9a2dae69"></script>
14+
<script src="_static/doctools.js?v=9bcbadda"></script>
1515
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="_static/cutter.js?v=b9d5d2df"></script>
1717
<link rel="index" title="Index" href="genindex.html" />
@@ -4858,7 +4858,7 @@ <h3 id="searchlabel">Quick search</h3>
48584858

48594859
<div class="footer" role="contentinfo">
48604860
&#169; Copyright 2020, The Cutter Developers.
4861-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
4861+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
48624862
</div>
48634863

48644864

‎docs/api/common/classAddressableFilterProxyModel.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<link rel="stylesheet" type="text/css" href="../../_static/cutter.css?v=3dc06d89" />
1212
<link rel="stylesheet" type="text/css" href="../../_static/admonitions.css?v=f99abf92" />
1313
<script src="../../_static/documentation_options.js?v=4d935f96"></script>
14-
<script src="../../_static/doctools.js?v=9a2dae69"></script>
14+
<script src="../../_static/doctools.js?v=9bcbadda"></script>
1515
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../_static/cutter.js?v=b9d5d2df"></script>
1717
<link rel="index" title="Index" href="../../genindex.html" />
@@ -204,7 +204,7 @@ <h3 id="searchlabel">Quick search</h3>
204204

205205
<div class="footer" role="contentinfo">
206206
&#169; Copyright 2020, The Cutter Developers.
207-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
207+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
208208
</div>
209209

210210

‎docs/api/common/classAddressableItemModel.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<link rel="stylesheet" type="text/css" href="../../_static/cutter.css?v=3dc06d89" />
1212
<link rel="stylesheet" type="text/css" href="../../_static/admonitions.css?v=f99abf92" />
1313
<script src="../../_static/documentation_options.js?v=4d935f96"></script>
14-
<script src="../../_static/doctools.js?v=9a2dae69"></script>
14+
<script src="../../_static/doctools.js?v=9bcbadda"></script>
1515
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../_static/cutter.js?v=b9d5d2df"></script>
1717
<link rel="index" title="Index" href="../../genindex.html" />
@@ -190,7 +190,7 @@ <h3 id="searchlabel">Quick search</h3>
190190

191191
<div class="footer" role="contentinfo">
192192
&#169; Copyright 2020, The Cutter Developers.
193-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
193+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
194194
</div>
195195

196196

‎docs/api/common/classAddressableItemModelI.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<link rel="stylesheet" type="text/css" href="../../_static/cutter.css?v=3dc06d89" />
1212
<link rel="stylesheet" type="text/css" href="../../_static/admonitions.css?v=f99abf92" />
1313
<script src="../../_static/documentation_options.js?v=4d935f96"></script>
14-
<script src="../../_static/doctools.js?v=9a2dae69"></script>
14+
<script src="../../_static/doctools.js?v=9bcbadda"></script>
1515
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../_static/cutter.js?v=b9d5d2df"></script>
1717
<link rel="index" title="Index" href="../../genindex.html" />
@@ -199,7 +199,7 @@ <h3 id="searchlabel">Quick search</h3>
199199

200200
<div class="footer" role="contentinfo">
201201
&#169; Copyright 2020, The Cutter Developers.
202-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
202+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
203203
</div>
204204

205205

‎docs/api/common/classAnalysisTask.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<link rel="stylesheet" type="text/css" href="../../_static/cutter.css?v=3dc06d89" />
1212
<link rel="stylesheet" type="text/css" href="../../_static/admonitions.css?v=f99abf92" />
1313
<script src="../../_static/documentation_options.js?v=4d935f96"></script>
14-
<script src="../../_static/doctools.js?v=9a2dae69"></script>
14+
<script src="../../_static/doctools.js?v=9bcbadda"></script>
1515
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../_static/cutter.js?v=b9d5d2df"></script>
1717
<link rel="index" title="Index" href="../../genindex.html" />
@@ -212,7 +212,7 @@ <h3 id="searchlabel">Quick search</h3>
212212

213213
<div class="footer" role="contentinfo">
214214
&#169; Copyright 2020, The Cutter Developers.
215-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
215+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
216216
</div>
217217

218218

‎docs/api/common/classAsyncTask.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<link rel="stylesheet" type="text/css" href="../../_static/cutter.css?v=3dc06d89" />
1212
<link rel="stylesheet" type="text/css" href="../../_static/admonitions.css?v=f99abf92" />
1313
<script src="../../_static/documentation_options.js?v=4d935f96"></script>
14-
<script src="../../_static/doctools.js?v=9a2dae69"></script>
14+
<script src="../../_static/doctools.js?v=9bcbadda"></script>
1515
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../_static/cutter.js?v=b9d5d2df"></script>
1717
<link rel="index" title="Index" href="../../genindex.html" />
@@ -256,7 +256,7 @@ <h3 id="searchlabel">Quick search</h3>
256256

257257
<div class="footer" role="contentinfo">
258258
&#169; Copyright 2020, The Cutter Developers.
259-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
259+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
260260
</div>
261261

262262

‎docs/api/common/classAsyncTaskManager.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<link rel="stylesheet" type="text/css" href="../../_static/cutter.css?v=3dc06d89" />
1212
<link rel="stylesheet" type="text/css" href="../../_static/admonitions.css?v=f99abf92" />
1313
<script src="../../_static/documentation_options.js?v=4d935f96"></script>
14-
<script src="../../_static/doctools.js?v=9a2dae69"></script>
14+
<script src="../../_static/doctools.js?v=9bcbadda"></script>
1515
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../_static/cutter.js?v=b9d5d2df"></script>
1717
<link rel="index" title="Index" href="../../genindex.html" />
@@ -202,7 +202,7 @@ <h3 id="searchlabel">Quick search</h3>
202202

203203
<div class="footer" role="contentinfo">
204204
&#169; Copyright 2020, The Cutter Developers.
205-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
205+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
206206
</div>
207207

208208

‎docs/api/common/classBasicBlockHighlighter.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<link rel="stylesheet" type="text/css" href="../../_static/cutter.css?v=3dc06d89" />
1212
<link rel="stylesheet" type="text/css" href="../../_static/admonitions.css?v=f99abf92" />
1313
<script src="../../_static/documentation_options.js?v=4d935f96"></script>
14-
<script src="../../_static/doctools.js?v=9a2dae69"></script>
14+
<script src="../../_static/doctools.js?v=9bcbadda"></script>
1515
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../_static/cutter.js?v=b9d5d2df"></script>
1717
<link rel="index" title="Index" href="../../genindex.html" />
@@ -216,7 +216,7 @@ <h3 id="searchlabel">Quick search</h3>
216216

217217
<div class="footer" role="contentinfo">
218218
&#169; Copyright 2020, The Cutter Developers.
219-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
219+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
220220
</div>
221221

222222

‎docs/api/common/classBasicInstructionHighlighter.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<link rel="stylesheet" type="text/css" href="../../_static/cutter.css?v=3dc06d89" />
1212
<link rel="stylesheet" type="text/css" href="../../_static/admonitions.css?v=f99abf92" />
1313
<script src="../../_static/documentation_options.js?v=4d935f96"></script>
14-
<script src="../../_static/doctools.js?v=9a2dae69"></script>
14+
<script src="../../_static/doctools.js?v=9bcbadda"></script>
1515
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../_static/cutter.js?v=b9d5d2df"></script>
1717
<link rel="index" title="Index" href="../../genindex.html" />
@@ -193,7 +193,7 @@ <h3 id="searchlabel">Quick search</h3>
193193

194194
<div class="footer" role="contentinfo">
195195
&#169; Copyright 2020, The Cutter Developers.
196-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
196+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
197197
</div>
198198

199199

‎docs/api/common/classCachedFontMetrics.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<link rel="stylesheet" type="text/css" href="../../_static/cutter.css?v=3dc06d89" />
1212
<link rel="stylesheet" type="text/css" href="../../_static/admonitions.css?v=f99abf92" />
1313
<script src="../../_static/documentation_options.js?v=4d935f96"></script>
14-
<script src="../../_static/doctools.js?v=9a2dae69"></script>
14+
<script src="../../_static/doctools.js?v=9bcbadda"></script>
1515
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../_static/cutter.js?v=b9d5d2df"></script>
1717
<link rel="index" title="Index" href="../../genindex.html" />
@@ -199,7 +199,7 @@ <h3 id="searchlabel">Quick search</h3>
199199

200200
<div class="footer" role="contentinfo">
201201
&#169; Copyright 2020, The Cutter Developers.
202-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
202+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
203203
</div>
204204

205205

‎docs/api/common/classColorThemeWorker.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<link rel="stylesheet" type="text/css" href="../../_static/cutter.css?v=3dc06d89" />
1212
<link rel="stylesheet" type="text/css" href="../../_static/admonitions.css?v=f99abf92" />
1313
<script src="../../_static/documentation_options.js?v=4d935f96"></script>
14-
<script src="../../_static/doctools.js?v=9a2dae69"></script>
14+
<script src="../../_static/doctools.js?v=9bcbadda"></script>
1515
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../_static/cutter.js?v=b9d5d2df"></script>
1717
<link rel="index" title="Index" href="../../genindex.html" />
@@ -352,7 +352,7 @@ <h3 id="searchlabel">Quick search</h3>
352352

353353
<div class="footer" role="contentinfo">
354354
&#169; Copyright 2020, The Cutter Developers.
355-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
355+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
356356
</div>
357357

358358

0 commit comments

Comments
 (0)