Skip to content

Commit 54710c9

Browse files
committed
deploy: 94d62c9
1 parent 7d7a800 commit 54710c9

File tree

81 files changed

+148
-94
lines changed

Some content is hidden

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

81 files changed

+148
-94
lines changed

.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 07d27718107b8d55e1e9baaf4f6e68f7
3+
config: 114ac48c9ddfd9bfa2229ccf6d511f32
44
tags: 645f666f9bcd5a90fca523b33c5a78b7
-8 Bytes
Binary file not shown.
-8 Bytes
Binary file not shown.

.doctrees/arch/namespaces.doctree

-8 Bytes
Binary file not shown.

.doctrees/arch/outputs.doctree

-8 Bytes
Binary file not shown.

.doctrees/arch/project_layout.doctree

-8 Bytes
Binary file not shown.
-8 Bytes
Binary file not shown.
-8 Bytes
Binary file not shown.

.doctrees/arch/style_guide.doctree

-8 Bytes
Binary file not shown.

.doctrees/arch/testing.doctree

-8 Bytes
Binary file not shown.

.doctrees/arch/toc.doctree

-8 Bytes
Binary file not shown.

.doctrees/environment.pickle

4.06 KB
Binary file not shown.

.doctrees/examples/clang.doctree

-8 Bytes
Binary file not shown.

.doctrees/examples/gcc.doctree

-8 Bytes
Binary file not shown.

.doctrees/examples/hybrid.doctree

-8 Bytes
Binary file not shown.

.doctrees/examples/mingw.doctree

-8 Bytes
Binary file not shown.

.doctrees/examples/msvc.doctree

-8 Bytes
Binary file not shown.

.doctrees/examples/toc.doctree

-8 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
-8 Bytes
Binary file not shown.

.doctrees/getting_started/toc.doctree

-8 Bytes
Binary file not shown.
-8 Bytes
Binary file not shown.

.doctrees/index.doctree

-8 Bytes
Binary file not shown.

.doctrees/intro/toc.doctree

-8 Bytes
Binary file not shown.

.doctrees/user_api/args.doctree

2.24 KB
Binary file not shown.
7.55 KB
Binary file not shown.

.doctrees/user_api/generator.doctree

-8 Bytes
Binary file not shown.

.doctrees/user_api/register.doctree

-1010 Bytes
Binary file not shown.
-8 Bytes
Binary file not shown.

.doctrees/user_api/target.doctree

-8 Bytes
Binary file not shown.
-8 Bytes
Binary file not shown.

.doctrees/user_api/toc.doctree

-8 Bytes
Binary file not shown.

.doctrees/user_api/toolchain.doctree

-8 Bytes
Binary file not shown.
-8 Bytes
Binary file not shown.

_static/doctools.js

Lines changed: 52 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -154,9 +154,7 @@ var Documentation = {
154154
this.fixFirefoxAnchorBug();
155155
this.highlightSearchWords();
156156
this.initIndexTable();
157-
if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
158-
this.initOnKeyListeners();
159-
}
157+
this.initOnKeyListeners();
160158
},
161159

162160
/**
@@ -269,6 +267,13 @@ var Documentation = {
269267
window.history.replaceState({}, '', url);
270268
},
271269

270+
/**
271+
* helper function to focus on search bar
272+
*/
273+
focusSearchBar : function() {
274+
$('input[name=q]').first().focus();
275+
},
276+
272277
/**
273278
* make the url absolute
274279
*/
@@ -291,27 +296,54 @@ var Documentation = {
291296
},
292297

293298
initOnKeyListeners: function() {
299+
// only install a listener if it is really needed
300+
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
301+
!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
302+
return;
303+
294304
$(document).keydown(function(event) {
295305
var activeElementType = document.activeElement.tagName;
296306
// don't navigate when in search box, textarea, dropdown or button
297307
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
298-
&& activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey
299-
&& !event.shiftKey) {
300-
switch (event.keyCode) {
301-
case 37: // left
302-
var prevHref = $('link[rel="prev"]').prop('href');
303-
if (prevHref) {
304-
window.location.href = prevHref;
305-
return false;
306-
}
307-
break;
308-
case 39: // right
309-
var nextHref = $('link[rel="next"]').prop('href');
310-
if (nextHref) {
311-
window.location.href = nextHref;
312-
return false;
313-
}
314-
break;
308+
&& activeElementType !== 'BUTTON') {
309+
if (event.altKey || event.ctrlKey || event.metaKey)
310+
return;
311+
312+
if (!event.shiftKey) {
313+
switch (event.key) {
314+
case 'ArrowLeft':
315+
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS)
316+
break;
317+
var prevHref = $('link[rel="prev"]').prop('href');
318+
if (prevHref) {
319+
window.location.href = prevHref;
320+
return false;
321+
}
322+
break;
323+
case 'ArrowRight':
324+
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS)
325+
break;
326+
var nextHref = $('link[rel="next"]').prop('href');
327+
if (nextHref) {
328+
window.location.href = nextHref;
329+
return false;
330+
}
331+
break;
332+
case 'Escape':
333+
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
334+
break;
335+
Documentation.hideSearchWords();
336+
return false;
337+
}
338+
}
339+
340+
// some keyboard layouts may need Shift to get /
341+
switch (event.key) {
342+
case '/':
343+
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
344+
break;
345+
Documentation.focusSearchBar();
346+
return false;
315347
}
316348
}
317349
});

_static/documentation_options.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,7 @@ var DOCUMENTATION_OPTIONS = {
88
LINK_SUFFIX: '.html',
99
HAS_SOURCE: true,
1010
SOURCELINK_SUFFIX: '.txt',
11-
NAVIGATION_WITH_KEYS: false
11+
NAVIGATION_WITH_KEYS: false,
12+
SHOW_SEARCH_SUMMARY: true,
13+
ENABLE_SEARCH_SHORTCUTS: true,
1214
};

_static/searchtools.js

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -172,10 +172,6 @@ var Search = {
172172
}
173173
// stem the word
174174
var word = stemmer.stemWord(tmp[i].toLowerCase());
175-
// prevent stemmer from cutting word smaller than two chars
176-
if(word.length < 3 && tmp[i].length >= 3) {
177-
word = tmp[i];
178-
}
179175
var toAppend;
180176
// select the correct list
181177
if (word[0] == '-') {
@@ -276,7 +272,7 @@ var Search = {
276272
setTimeout(function() {
277273
displayNextItem();
278274
}, 5);
279-
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
275+
} else if (DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY) {
280276
$.ajax({url: requestUrl,
281277
dataType: "text",
282278
complete: function(jqxhr, textstatus) {
@@ -293,7 +289,7 @@ var Search = {
293289
}, 5);
294290
}});
295291
} else {
296-
// no source available, just display title
292+
// just display title
297293
Search.output.append(listItem);
298294
setTimeout(function() {
299295
displayNextItem();

arch/cmake_boilerplate.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Namespaces" href="namespaces.html" /><link rel="prev" title="Serialization Schema" href="serialization_schema.html" />
66

7-
<meta name="generator" content="sphinx-4.4.0, furo 2022.03.04"/>
7+
<meta name="generator" content="sphinx-4.5.0, furo 2022.03.04"/>
88
<title>CMake Boilerplate - BuildCC 0.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=935aa2abcc5c1da4283d1dc201fb1f0add16d23a" />

arch/design_patterns.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Testing" href="testing.html" /><link rel="prev" title="Namespaces" href="namespaces.html" />
66

7-
<meta name="generator" content="sphinx-4.4.0, furo 2022.03.04"/>
7+
<meta name="generator" content="sphinx-4.5.0, furo 2022.03.04"/>
88
<title>Design Patterns - BuildCC 0.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=935aa2abcc5c1da4283d1dc201fb1f0add16d23a" />

arch/namespaces.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Design Patterns" href="design_patterns.html" /><link rel="prev" title="CMake Boilerplate" href="cmake_boilerplate.html" />
66

7-
<meta name="generator" content="sphinx-4.4.0, furo 2022.03.04"/>
7+
<meta name="generator" content="sphinx-4.5.0, furo 2022.03.04"/>
88
<title>Namespaces - BuildCC 0.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=935aa2abcc5c1da4283d1dc201fb1f0add16d23a" />

arch/outputs.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Style Guide" href="style_guide.html" /><link rel="prev" title="Testing" href="testing.html" />
66

7-
<meta name="generator" content="sphinx-4.4.0, furo 2022.03.04"/>
7+
<meta name="generator" content="sphinx-4.5.0, furo 2022.03.04"/>
88
<title>Outputs - BuildCC 0.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=935aa2abcc5c1da4283d1dc201fb1f0add16d23a" />

arch/project_layout.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Software Heirarchy" href="software_heirarchy.html" /><link rel="prev" title="Architecture" href="toc.html" />
66

7-
<meta name="generator" content="sphinx-4.4.0, furo 2022.03.04"/>
7+
<meta name="generator" content="sphinx-4.5.0, furo 2022.03.04"/>
88
<title>Project Layout - BuildCC 0.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=935aa2abcc5c1da4283d1dc201fb1f0add16d23a" />

arch/serialization_schema.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="CMake Boilerplate" href="cmake_boilerplate.html" /><link rel="prev" title="Software Heirarchy" href="software_heirarchy.html" />
66

7-
<meta name="generator" content="sphinx-4.4.0, furo 2022.03.04"/>
7+
<meta name="generator" content="sphinx-4.5.0, furo 2022.03.04"/>
88
<title>Serialization Schema - BuildCC 0.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=935aa2abcc5c1da4283d1dc201fb1f0add16d23a" />

arch/software_heirarchy.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Serialization Schema" href="serialization_schema.html" /><link rel="prev" title="Project Layout" href="project_layout.html" />
66

7-
<meta name="generator" content="sphinx-4.4.0, furo 2022.03.04"/>
7+
<meta name="generator" content="sphinx-4.5.0, furo 2022.03.04"/>
88
<title>Software Heirarchy - BuildCC 0.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=935aa2abcc5c1da4283d1dc201fb1f0add16d23a" />

arch/style_guide.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Getting Started" href="../getting_started/toc.html" /><link rel="prev" title="Outputs" href="outputs.html" />
66

7-
<meta name="generator" content="sphinx-4.4.0, furo 2022.03.04"/>
7+
<meta name="generator" content="sphinx-4.5.0, furo 2022.03.04"/>
88
<title>Style Guide - BuildCC 0.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=935aa2abcc5c1da4283d1dc201fb1f0add16d23a" />

arch/testing.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Outputs" href="outputs.html" /><link rel="prev" title="Design Patterns" href="design_patterns.html" />
66

7-
<meta name="generator" content="sphinx-4.4.0, furo 2022.03.04"/>
7+
<meta name="generator" content="sphinx-4.5.0, furo 2022.03.04"/>
88
<title>Testing - BuildCC 0.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=935aa2abcc5c1da4283d1dc201fb1f0add16d23a" />

arch/toc.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Project Layout" href="project_layout.html" /><link rel="prev" title="Introduction" href="../intro/toc.html" />
66

7-
<meta name="generator" content="sphinx-4.4.0, furo 2022.03.04"/>
7+
<meta name="generator" content="sphinx-4.5.0, furo 2022.03.04"/>
88
<title>Architecture - BuildCC 0.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=935aa2abcc5c1da4283d1dc201fb1f0add16d23a" />

examples/clang.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="MinGW" href="mingw.html" /><link rel="prev" title="MSVC" href="msvc.html" />
66

7-
<meta name="generator" content="sphinx-4.4.0, furo 2022.03.04"/>
7+
<meta name="generator" content="sphinx-4.5.0, furo 2022.03.04"/>
88
<title>Clang - BuildCC 0.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=935aa2abcc5c1da4283d1dc201fb1f0add16d23a" />

examples/gcc.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="MSVC" href="msvc.html" /><link rel="prev" title="Hybrid" href="hybrid.html" />
66

7-
<meta name="generator" content="sphinx-4.4.0, furo 2022.03.04"/>
7+
<meta name="generator" content="sphinx-4.5.0, furo 2022.03.04"/>
88
<title>GCC - BuildCC 0.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=935aa2abcc5c1da4283d1dc201fb1f0add16d23a" />

examples/hybrid.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="GCC" href="gcc.html" /><link rel="prev" title="Examples" href="toc.html" />
66

7-
<meta name="generator" content="sphinx-4.4.0, furo 2022.03.04"/>
7+
<meta name="generator" content="sphinx-4.5.0, furo 2022.03.04"/>
88
<title>Hybrid - BuildCC 0.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=935aa2abcc5c1da4283d1dc201fb1f0add16d23a" />

examples/mingw.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="prev" title="Clang" href="clang.html" />
66

7-
<meta name="generator" content="sphinx-4.4.0, furo 2022.03.04"/>
7+
<meta name="generator" content="sphinx-4.5.0, furo 2022.03.04"/>
88
<title>MinGW - BuildCC 0.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=935aa2abcc5c1da4283d1dc201fb1f0add16d23a" />

examples/msvc.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Clang" href="clang.html" /><link rel="prev" title="GCC" href="gcc.html" />
66

7-
<meta name="generator" content="sphinx-4.4.0, furo 2022.03.04"/>
7+
<meta name="generator" content="sphinx-4.5.0, furo 2022.03.04"/>
88
<title>MSVC - BuildCC 0.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=935aa2abcc5c1da4283d1dc201fb1f0add16d23a" />

examples/toc.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Hybrid" href="hybrid.html" /><link rel="prev" title="Environment" href="../user_api/environment.html" />
66

7-
<meta name="generator" content="sphinx-4.4.0, furo 2022.03.04"/>
7+
<meta name="generator" content="sphinx-4.5.0, furo 2022.03.04"/>
88
<title>Examples - BuildCC 0.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=935aa2abcc5c1da4283d1dc201fb1f0add16d23a" />

0 commit comments

Comments
 (0)