Skip to content

Commit 995066b

Browse files
committed
Fix typo in changelog, switch to Sphinx 4
1 parent b403dfb commit 995066b

Some content is hidden

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

67 files changed

+4027
-7377
lines changed

documentation/requirements.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
Sphinx==3.4.3
2-
sphinx-rtd-theme==0.5.1
3-
docutils==0.16
1+
Sphinx==4.4.0
2+
sphinx-rtd-theme==1.0.0
3+
docutils==0.17.1

documentation/source/changelog.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Changelog
22
=========
33

44
January 11, 2023 - bake-toolkit 2.72.0
5-
* Change all deprecated functions ``File.exists`` to ``File.exist``for compatibility to Ruby 3.2.
5+
* Change all deprecated functions ``File.exists`` to ``File.exist`` for compatibility to Ruby 3.2.
66

77
December 13, 2021 - bake-toolkit 2.71.0
88
* Add ``--abs-paths-in`` for compiler command lines and ``--abs-paths-out`` for compiler output. This splits the still existing ``--abs-paths``.

install-docs/.buildinfo

+1-1
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: 088dc4c60cab0e1d7dd89d5720b3917a
3+
config: 81a648d57eb1519cbae534949116cb44
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

install-docs/_sources/source/changelog.rst.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Changelog
22
=========
33

44
January 11, 2023 - bake-toolkit 2.72.0
5-
* Change all deprecated functions ``File.exists`` to ``File.exist``for compatibility to Ruby 3.2.
5+
* Change all deprecated functions ``File.exists`` to ``File.exist`` for compatibility to Ruby 3.2.
66

77
December 13, 2021 - bake-toolkit 2.71.0
88
* Add ``--abs-paths-in`` for compiler command lines and ``--abs-paths-out`` for compiler output. This splits the still existing ``--abs-paths``.

install-docs/_static/basic.css

+82-32
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx stylesheet -- basic theme.
66
*
7-
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/
@@ -130,7 +130,7 @@ ul.search li a {
130130
font-weight: bold;
131131
}
132132

133-
ul.search li div.context {
133+
ul.search li p.context {
134134
color: #888;
135135
margin: 2px 0 0 30px;
136136
text-align: left;
@@ -277,25 +277,25 @@ p.rubric {
277277
font-weight: bold;
278278
}
279279

280-
img.align-left, .figure.align-left, object.align-left {
280+
img.align-left, figure.align-left, .figure.align-left, object.align-left {
281281
clear: left;
282282
float: left;
283283
margin-right: 1em;
284284
}
285285

286-
img.align-right, .figure.align-right, object.align-right {
286+
img.align-right, figure.align-right, .figure.align-right, object.align-right {
287287
clear: right;
288288
float: right;
289289
margin-left: 1em;
290290
}
291291

292-
img.align-center, .figure.align-center, object.align-center {
292+
img.align-center, figure.align-center, .figure.align-center, object.align-center {
293293
display: block;
294294
margin-left: auto;
295295
margin-right: auto;
296296
}
297297

298-
img.align-default, .figure.align-default {
298+
img.align-default, figure.align-default, .figure.align-default {
299299
display: block;
300300
margin-left: auto;
301301
margin-right: auto;
@@ -319,7 +319,8 @@ img.align-default, .figure.align-default {
319319

320320
/* -- sidebars -------------------------------------------------------------- */
321321

322-
div.sidebar {
322+
div.sidebar,
323+
aside.sidebar {
323324
margin: 0 0 0.5em 1em;
324325
border: 1px solid #ddb;
325326
padding: 7px;
@@ -377,12 +378,14 @@ div.body p.centered {
377378
/* -- content of sidebars/topics/admonitions -------------------------------- */
378379

379380
div.sidebar > :last-child,
381+
aside.sidebar > :last-child,
380382
div.topic > :last-child,
381383
div.admonition > :last-child {
382384
margin-bottom: 0;
383385
}
384386

385387
div.sidebar::after,
388+
aside.sidebar::after,
386389
div.topic::after,
387390
div.admonition::after,
388391
blockquote::after {
@@ -455,20 +458,22 @@ td > :last-child {
455458

456459
/* -- figures --------------------------------------------------------------- */
457460

458-
div.figure {
461+
div.figure, figure {
459462
margin: 0.5em;
460463
padding: 0.5em;
461464
}
462465

463-
div.figure p.caption {
466+
div.figure p.caption, figcaption {
464467
padding: 0.3em;
465468
}
466469

467-
div.figure p.caption span.caption-number {
470+
div.figure p.caption span.caption-number,
471+
figcaption span.caption-number {
468472
font-style: italic;
469473
}
470474

471-
div.figure p.caption span.caption-text {
475+
div.figure p.caption span.caption-text,
476+
figcaption span.caption-text {
472477
}
473478

474479
/* -- field list styles ----------------------------------------------------- */
@@ -503,6 +508,63 @@ table.hlist td {
503508
vertical-align: top;
504509
}
505510

511+
/* -- object description styles --------------------------------------------- */
512+
513+
.sig {
514+
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
515+
}
516+
517+
.sig-name, code.descname {
518+
background-color: transparent;
519+
font-weight: bold;
520+
}
521+
522+
.sig-name {
523+
font-size: 1.1em;
524+
}
525+
526+
code.descname {
527+
font-size: 1.2em;
528+
}
529+
530+
.sig-prename, code.descclassname {
531+
background-color: transparent;
532+
}
533+
534+
.optional {
535+
font-size: 1.3em;
536+
}
537+
538+
.sig-paren {
539+
font-size: larger;
540+
}
541+
542+
.sig-param.n {
543+
font-style: italic;
544+
}
545+
546+
/* C++ specific styling */
547+
548+
.sig-inline.c-texpr,
549+
.sig-inline.cpp-texpr {
550+
font-family: unset;
551+
}
552+
553+
.sig.c .k, .sig.c .kt,
554+
.sig.cpp .k, .sig.cpp .kt {
555+
color: #0033B3;
556+
}
557+
558+
.sig.c .m,
559+
.sig.cpp .m {
560+
color: #1750EB;
561+
}
562+
563+
.sig.c .s, .sig.c .sc,
564+
.sig.cpp .s, .sig.cpp .sc {
565+
color: #067D17;
566+
}
567+
506568

507569
/* -- other body styles ----------------------------------------------------- */
508570

@@ -629,14 +691,6 @@ dl.glossary dt {
629691
font-size: 1.1em;
630692
}
631693

632-
.optional {
633-
font-size: 1.3em;
634-
}
635-
636-
.sig-paren {
637-
font-size: larger;
638-
}
639-
640694
.versionmodified {
641695
font-style: italic;
642696
}
@@ -677,8 +731,9 @@ dl.glossary dt {
677731

678732
.classifier:before {
679733
font-style: normal;
680-
margin: 0.5em;
734+
margin: 0 0.5em;
681735
content: ":";
736+
display: inline-block;
682737
}
683738

684739
abbr, acronym {
@@ -702,6 +757,7 @@ span.pre {
702757
-ms-hyphens: none;
703758
-webkit-hyphens: none;
704759
hyphens: none;
760+
white-space: nowrap;
705761
}
706762

707763
div[class*="highlight-"] {
@@ -765,8 +821,12 @@ div.code-block-caption code {
765821

766822
table.highlighttable td.linenos,
767823
span.linenos,
768-
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
769-
user-select: none;
824+
div.highlight span.gp { /* gp: Generic.Prompt */
825+
user-select: none;
826+
-webkit-user-select: text; /* Safari fallback only */
827+
-webkit-user-select: none; /* Chrome/Safari */
828+
-moz-user-select: none; /* Firefox */
829+
-ms-user-select: none; /* IE10+ */
770830
}
771831

772832
div.code-block-caption span.caption-number {
@@ -781,16 +841,6 @@ div.literal-block-wrapper {
781841
margin: 1em 0;
782842
}
783843

784-
code.descname {
785-
background-color: transparent;
786-
font-weight: bold;
787-
font-size: 1.2em;
788-
}
789-
790-
code.descclassname {
791-
background-color: transparent;
792-
}
793-
794844
code.xref, a code {
795845
background-color: transparent;
796846
font-weight: bold;

install-docs/_static/css/theme.css

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

install-docs/_static/doctools.js

+12-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx JavaScript utilities for all documentation.
66
*
7-
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/
@@ -29,9 +29,14 @@ if (!window.console || !console.firebug) {
2929

3030
/**
3131
* small helper function to urldecode strings
32+
*
33+
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
3234
*/
3335
jQuery.urldecode = function(x) {
34-
return decodeURIComponent(x).replace(/\+/g, ' ');
36+
if (!x) {
37+
return x
38+
}
39+
return decodeURIComponent(x.replace(/\+/g, ' '));
3540
};
3641

3742
/**
@@ -259,6 +264,9 @@ var Documentation = {
259264
hideSearchWords : function() {
260265
$('#searchbox .highlight-link').fadeOut(300);
261266
$('span.highlighted').removeClass('highlighted');
267+
var url = new URL(window.location);
268+
url.searchParams.delete('highlight');
269+
window.history.replaceState({}, '', url);
262270
},
263271

264272
/**
@@ -296,12 +304,14 @@ var Documentation = {
296304
window.location.href = prevHref;
297305
return false;
298306
}
307+
break;
299308
case 39: // right
300309
var nextHref = $('link[rel="next"]').prop('href');
301310
if (nextHref) {
302311
window.location.href = nextHref;
303312
return false;
304313
}
314+
break;
305315
}
306316
}
307317
});

install-docs/_static/js/theme.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

install-docs/_static/language_data.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,16 @@
55
* This script contains the language-specific data used by searchtools.js,
66
* namely the list of stopwords, stemmer, scorer and splitter.
77
*
8-
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
8+
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
99
* :license: BSD, see LICENSE for details.
1010
*
1111
*/
1212

1313
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"];
1414

1515

16-
/* Non-minified version JS is _stemmer.js if file is provided */
16+
/* Non-minified version is copied as a separate JS file, is available */
17+
1718
/**
1819
* Porter Stemmer
1920
*/
@@ -199,7 +200,6 @@ var Stemmer = function() {
199200

200201

201202

202-
203203
var splitChars = (function() {
204204
var result = {};
205205
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,

0 commit comments

Comments
 (0)