Skip to content

Commit 2433683

Browse files
mwydmuchmwydmuch
committed
Deploying to gh-pages from @ 227d0c9 🚀
1 parent 367870f commit 2433683

File tree

37 files changed

+672
-640
lines changed

37 files changed

+672
-640
lines changed

‎.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: 93b0282c7be02795ed590f3ed414b31b
3+
config: cf8a2fc7578cf0ef93e75a0ab9d6cfc2
44
tags: d77d1c0d9ca2f4c8421862c7c5a0d620

‎404.html

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!doctype html>
2-
<html class="no-js" lang="en">
2+
<html class="no-js" lang="en" data-content_root="../">
33
<head><meta charset="utf-8"/>
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark">
@@ -11,11 +11,11 @@
1111
<link rel="index" title="Index" href="/genindex/" /><link rel="search" title="Search" href="/search/" />
1212
<link rel="canonical" href="https://vizdoom.farama.org/404.html" />
1313

14-
<link rel="shortcut icon" href="/_static/favicon.png"/><!-- Generated with Sphinx 7.1.2 and Furo 2023.05.20.dev1 -->
14+
<link rel="shortcut icon" href="/_static/favicon.png"/><!-- Generated with Sphinx 7.2.5 and Furo 2023.08.19.dev1 -->
1515
<title>404 - Page Not Found - ViZDoom Documentation</title>
1616
<link rel="stylesheet" type="text/css" href="/_static/pygments.css?v=a746c00c" />
17-
<link rel="stylesheet" type="text/css" href="/_static/styles/furo.css?digest=2b6f8eb5452c44539a42dd9ada0a48f56e5f404d" />
18-
<link rel="stylesheet" type="text/css" href="/_static/styles/furo-extensions.css?digest=5d0deb98f4b2e6cecaee64745957f1068f205919" />
17+
<link rel="stylesheet" type="text/css" href="/_static/styles/furo.css?v=3e7f4c72" />
18+
<link rel="stylesheet" type="text/css" href="/_static/styles/furo-extensions.css?v=49cbaffd" />
1919

2020

2121

@@ -311,9 +311,9 @@
311311
<article role="main">
312312

313313
<section id="page-not-found">
314-
<h1>404 - Page Not Found<a class="headerlink" href="#page-not-found" title="Permalink to this heading">#</a></h1>
314+
<h1>404 - Page Not Found<a class="headerlink" href="#page-not-found" title="Link to this heading">#</a></h1>
315315
<section id="the-requested-page-could-not-be-found">
316-
<h2>The requested page could not be found.<a class="headerlink" href="#the-requested-page-could-not-be-found" title="Permalink to this heading">#</a></h2>
316+
<h2>The requested page could not be found.<a class="headerlink" href="#the-requested-page-could-not-be-found" title="Link to this heading">#</a></h2>
317317
</section>
318318
</section>
319319

@@ -433,9 +433,9 @@ <h2>The requested page could not be found.<a class="headerlink" href="#the-reque
433433
})()
434434
</script>
435435

436-
<script data-url_root="../" id="documentation_options" src="/_static/documentation_options.js?v=dda0c7a7"></script>
436+
<script src="/_static/documentation_options.js?v=a5603611"></script>
437437
<script src="/_static/doctools.js?v=888ff710"></script>
438-
<script src="/_static/sphinx_highlight.js?v=4825356b"></script>
438+
<script src="/_static/sphinx_highlight.js?v=dc90522c"></script>
439439
<script src="/_static/scripts/furo.js?v=7660844c"></script>
440440

441441
<script>

‎README/index.html

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!doctype html>
2-
<html class="no-js" lang="en">
2+
<html class="no-js" lang="en" data-content_root="../">
33
<head><meta charset="utf-8"/>
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark">
@@ -11,11 +11,11 @@
1111
<link rel="index" title="Index" href="../genindex/" /><link rel="search" title="Search" href="../search/" />
1212
<link rel="canonical" href="https://vizdoom.farama.org/README.html" />
1313

14-
<link rel="shortcut icon" href="../_static/favicon.png"/><!-- Generated with Sphinx 7.1.2 and Furo 2023.05.20.dev1 -->
14+
<link rel="shortcut icon" href="../_static/favicon.png"/><!-- Generated with Sphinx 7.2.5 and Furo 2023.08.19.dev1 -->
1515
<title>ViZDoom documentation - ViZDoom Documentation</title>
1616
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
17-
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=2b6f8eb5452c44539a42dd9ada0a48f56e5f404d" />
18-
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=5d0deb98f4b2e6cecaee64745957f1068f205919" />
17+
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=3e7f4c72" />
18+
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=49cbaffd" />
1919

2020

2121

@@ -311,7 +311,7 @@
311311
<article role="main">
312312

313313
<section id="vizdoom-documentation">
314-
<h1>ViZDoom documentation<a class="headerlink" href="#vizdoom-documentation" title="Permalink to this heading">#</a></h1>
314+
<h1>ViZDoom documentation<a class="headerlink" href="#vizdoom-documentation" title="Link to this heading">#</a></h1>
315315
<p>This directory contains the documentation for ViZDOOm.</p>
316316
<p>For more information about how to contribute to the documentation go to our <a class="reference external" href="https://github.com/Farama-Foundation/Celshast/blob/main/CONTRIBUTING.md">CONTRIBUTING.md</a></p>
317317
<p>If you edit the C++ documentation (inside <code class="docutils literal notranslate"><span class="pre">api_cpp</span></code>), you need to run to update other files:</p>
@@ -437,9 +437,9 @@ <h1>ViZDoom documentation<a class="headerlink" href="#vizdoom-documentation" tit
437437
})()
438438
</script>
439439

440-
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=dda0c7a7"></script>
440+
<script src="../_static/documentation_options.js?v=a5603611"></script>
441441
<script src="../_static/doctools.js?v=888ff710"></script>
442-
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
442+
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
443443
<script src="../_static/scripts/furo.js?v=7660844c"></script>
444444

445445
<script>

‎_static/basic.css

+4
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,10 @@ a.headerlink {
237237
visibility: hidden;
238238
}
239239

240+
a:visited {
241+
color: #551A8B;
242+
}
243+
240244
h1:hover > a.headerlink,
241245
h2:hover > a.headerlink,
242246
h3:hover > a.headerlink,

‎_static/documentation_options.js

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
var DOCUMENTATION_OPTIONS = {
2-
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
1+
const DOCUMENTATION_OPTIONS = {
32
VERSION: '',
43
LANGUAGE: 'en',
54
COLLAPSE_INDEX: false,

‎_static/searchtools.js

+17-9
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,12 @@ const _removeChildren = (element) => {
5757
const _escapeRegExp = (string) =>
5858
string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
5959

60-
const _displayItem = (item, searchTerms) => {
60+
const _displayItem = (item, searchTerms, highlightTerms) => {
6161
const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
62-
const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT;
6362
const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
6463
const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
6564
const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
65+
const contentRoot = document.documentElement.dataset.content_root;
6666

6767
const [docName, title, anchor, descr, score, _filename] = item;
6868

@@ -75,20 +75,24 @@ const _displayItem = (item, searchTerms) => {
7575
if (dirname.match(/\/index\/$/))
7676
dirname = dirname.substring(0, dirname.length - 6);
7777
else if (dirname === "index/") dirname = "";
78-
requestUrl = docUrlRoot + dirname;
78+
requestUrl = contentRoot + dirname;
7979
linkUrl = requestUrl;
8080
} else {
8181
// normal html builders
82-
requestUrl = docUrlRoot + docName + docFileSuffix;
82+
requestUrl = contentRoot + docName + docFileSuffix;
8383
linkUrl = docName + docLinkSuffix;
8484
}
8585
let linkEl = listItem.appendChild(document.createElement("a"));
8686
linkEl.href = linkUrl + anchor;
8787
linkEl.dataset.score = score;
8888
linkEl.innerHTML = title;
89-
if (descr)
89+
if (descr) {
9090
listItem.appendChild(document.createElement("span")).innerHTML =
9191
" (" + descr + ")";
92+
// highlight search terms in the description
93+
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
94+
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
95+
}
9296
else if (showSearchSummary)
9397
fetch(requestUrl)
9498
.then((responseData) => responseData.text())
@@ -97,6 +101,9 @@ const _displayItem = (item, searchTerms) => {
97101
listItem.appendChild(
98102
Search.makeSearchSummary(data, searchTerms)
99103
);
104+
// highlight search terms in the summary
105+
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
106+
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
100107
});
101108
Search.output.appendChild(listItem);
102109
};
@@ -115,14 +122,15 @@ const _finishSearch = (resultCount) => {
115122
const _displayNextItem = (
116123
results,
117124
resultCount,
118-
searchTerms
125+
searchTerms,
126+
highlightTerms,
119127
) => {
120128
// results left, load the summary and display it
121129
// this is intended to be dynamic (don't sub resultsCount)
122130
if (results.length) {
123-
_displayItem(results.pop(), searchTerms);
131+
_displayItem(results.pop(), searchTerms, highlightTerms);
124132
setTimeout(
125-
() => _displayNextItem(results, resultCount, searchTerms),
133+
() => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
126134
5
127135
);
128136
}
@@ -360,7 +368,7 @@ const Search = {
360368
// console.info("search results:", Search.lastresults);
361369

362370
// print the results
363-
_displayNextItem(results, results.length, searchTerms);
371+
_displayNextItem(results, results.length, searchTerms, highlightTerms);
364372
},
365373

366374
/**

‎_static/sphinx_highlight.js

+13-3
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,19 @@ const _highlight = (node, addItems, text, className) => {
2929
}
3030

3131
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
32+
const rest = document.createTextNode(val.substr(pos + text.length));
3233
parent.insertBefore(
3334
span,
3435
parent.insertBefore(
35-
document.createTextNode(val.substr(pos + text.length)),
36+
rest,
3637
node.nextSibling
3738
)
3839
);
3940
node.nodeValue = val.substr(0, pos);
41+
/* There may be more occurrences of search term in this node. So call this
42+
* function recursively on the remaining fragment.
43+
*/
44+
_highlight(rest, addItems, text, className);
4045

4146
if (isInSVG) {
4247
const rect = document.createElementNS(
@@ -140,5 +145,10 @@ const SphinxHighlight = {
140145
},
141146
};
142147

143-
_ready(SphinxHighlight.highlightSearchWords);
144-
_ready(SphinxHighlight.initEscapeListener);
148+
_ready(() => {
149+
/* Do not call highlightSearchWords() when we are on the search page.
150+
* It will highlight words from the *previous* search query.
151+
*/
152+
if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
153+
SphinxHighlight.initEscapeListener();
154+
});

‎_static/styles/furo.css

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

‎_static/styles/furo.css.map

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

‎_static/versioning/versioning_menu.html

+18-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
<div class="versions_menu">
22
<div class="versions_menu__header">
33
<span id="versions_menu-current-version"></span>
4-
<i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i>
4+
<i class="icon"><svg>
5+
<use href="#svg-arrow-right"></use>
6+
</svg></i>
57
<!-- Current Version -->
68
</div>
79
<div class="versions_menu__content">
@@ -17,12 +19,14 @@
1719
right: 30px;
1820
font-family: var(--font-stack, -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji);
1921
border: 1px solid var(--color-background-border, #eeebee);
22+
border-radius: 8px 8px 0 0;
2023
z-index: 98;
24+
overflow: hidden;
2125
}
2226

2327
.versions_menu__header {
2428
display: flex;
25-
padding: 8px 10px;
29+
padding: 10px 12px;
2630
font-size: 14px;
2731
border-bottom: 1px solid var(--color-background-border, #eeebee);
2832
background-color: var(--color-background-secondary, #f8f9fb);
@@ -55,7 +59,8 @@
5559
}
5660

5761
.versions_menu.active .versions_menu__content {
58-
max-height: 200px;
62+
max-height: 300px;
63+
overflow: auto;
5964
}
6065

6166
.versions_menu__content span {
@@ -72,20 +77,23 @@
7277
margin: 0;
7378
}
7479

75-
.versions_menu__list li {}
80+
.versions_menu__list li {
81+
border-radius: 4px;
82+
}
7683

7784
.versions_menu__list li a {
7885
display: block;
79-
padding: 4px 10px;
86+
padding: 6px 10px;
8087
font-size: 14px;
81-
color: var(--color-link, #2962ff);
88+
color: var(--color-content-foreground, "#000");
8289
text-decoration: none;
8390
cursor: pointer;
8491
}
8592

8693
.versions_menu__list li:hover {
87-
background-color: var(--color-background-hover, #efeff4)
94+
background-color: var(--color-sidebar-item-background--hover, #efeff4)
8895
}
96+
8997
@media screen and (max-width: 400px) {
9098
.versions_menu__content {
9199
width: 140px;
@@ -114,6 +122,9 @@
114122
});
115123

116124
const sortVersions = (a, b) => {
125+
// Alpha versions
126+
if (a.includes("a")) return 1;
127+
if (b.includes("a")) return -1;
117128
if (a.replace("v", "") > b.replace("v", ""))
118129
return -1
119130
else if (a.replace("v", "") < b.replace("v", ""))

‎api/configurationFiles/index.html

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!doctype html>
2-
<html class="no-js" lang="en">
2+
<html class="no-js" lang="en" data-content_root="../../">
33
<head><meta charset="utf-8"/>
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark">
@@ -11,11 +11,11 @@
1111
<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Default scenarios/environments" href="../../environments/default/" /><link rel="prev" title="Utilities" href="../cpp/utils/" />
1212
<link rel="canonical" href="https://vizdoom.farama.org/api/configurationFiles.html" />
1313

14-
<link rel="shortcut icon" href="../../_static/favicon.png"/><!-- Generated with Sphinx 7.1.2 and Furo 2023.05.20.dev1 -->
14+
<link rel="shortcut icon" href="../../_static/favicon.png"/><!-- Generated with Sphinx 7.2.5 and Furo 2023.08.19.dev1 -->
1515
<title>Configuration files - ViZDoom Documentation</title>
1616
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
17-
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=2b6f8eb5452c44539a42dd9ada0a48f56e5f404d" />
18-
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=5d0deb98f4b2e6cecaee64745957f1068f205919" />
17+
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=3e7f4c72" />
18+
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=49cbaffd" />
1919

2020

2121

@@ -311,10 +311,10 @@
311311
<article role="main">
312312

313313
<section id="configuration-files">
314-
<h1>Configuration files<a class="headerlink" href="#configuration-files" title="Permalink to this heading">#</a></h1>
314+
<h1>Configuration files<a class="headerlink" href="#configuration-files" title="Link to this heading">#</a></h1>
315315
<p>Instead of configuring the ViZDoom in code, you can load it from the configuration file(s). Each file is read sequentially, so multiple entries with the same key will overwrite previous entries.</p>
316316
<section id="format">
317-
<h2>Format<a class="headerlink" href="#format" title="Permalink to this heading">#</a></h2>
317+
<h2>Format<a class="headerlink" href="#format" title="Link to this heading">#</a></h2>
318318
<p>Each entry in a configraution file is a pair of <strong>key</strong> and <strong>value</strong> separated by an equal sign (<strong>“=”</strong>). The file format should also abide the following rules:</p>
319319
<ul class="simple">
320320
<li><p>one entry per line (except for list parameters),</p></li>
@@ -325,15 +325,15 @@ <h2>Format<a class="headerlink" href="#format" title="Permalink to this heading"
325325
</ul>
326326
<p>A violation of any of these rules will result in ignoring <strong>only</strong> the line with the error and sending a warning message to stderr (“WARNING! Loading config from: …”).</p>
327327
<section id="list-of-values">
328-
<h3>List of values<a class="headerlink" href="#list-of-values" title="Permalink to this heading">#</a></h3>
328+
<h3>List of values<a class="headerlink" href="#list-of-values" title="Link to this heading">#</a></h3>
329329
<p><strong>available_buttons</strong> and <strong>available_game_variables</strong> are special parameters, which use multiple values and instead of a single value they expect a list of values separated by whitespaces and enclosed within braces (“{” and “}”). The list can stretch throughout multiple lines as long as all values are separated from each other by whitespaces.</p>
330330
</section>
331331
<section id="appending-values">
332-
<h3>Appending values<a class="headerlink" href="#appending-values" title="Permalink to this heading">#</a></h3>
332+
<h3>Appending values<a class="headerlink" href="#appending-values" title="Link to this heading">#</a></h3>
333333
<p>Each list assignment (<strong>KEY = { VALUES }</strong>)clears values specified for this key before (in other configuration files or in the code). That is why the *<em>append operator(<em>KEY += { VALUES })</em></em> is available. This way you can more easily combine multiple configuration files and tinker in code.</p>
334334
</section>
335335
<section id="supported-configuration-keys">
336-
<h3>Supported configuration keys:<a class="headerlink" href="#supported-configuration-keys" title="Permalink to this heading">#</a></h3>
336+
<h3>Supported configuration keys:<a class="headerlink" href="#supported-configuration-keys" title="Link to this heading">#</a></h3>
337337
<ul class="simple">
338338
<li><p><code class="docutils literal notranslate"><span class="pre">audioBufferEnabled/audio_buffer_enabled</span></code></p></li>
339339
<li><p><code class="docutils literal notranslate"><span class="pre">audioBufferSize/audio_buffer_size</span></code></p></li>
@@ -382,7 +382,7 @@ <h3>Supported configuration keys:<a class="headerlink" href="#supported-configur
382382
<p>See also: <a class="reference internal" href="#DoomGame.md"><span class="xref myst"><code class="docutils literal notranslate"><span class="pre">DoomGame</span></code></span></a> for config keys and functions related to them.</p>
383383
</section>
384384
<section id="sample-configuration-file-content">
385-
<h3>Sample configuration file content:<a class="headerlink" href="#sample-configuration-file-content" title="Permalink to this heading">#</a></h3>
385+
<h3>Sample configuration file content:<a class="headerlink" href="#sample-configuration-file-content" title="Link to this heading">#</a></h3>
386386
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="na">vizdoom_path</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">../../bin/vizdoom</span>
387387
<span class="c1">#doom_game_path = ../../scenarios/doom2.wad</span>
388388
<span class="na">doom_game_path</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">../../scenarios/freedoom2.wad</span>
@@ -594,9 +594,9 @@ <h3>Sample configuration file content:<a class="headerlink" href="#sample-config
594594
})()
595595
</script>
596596

597-
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=dda0c7a7"></script>
597+
<script src="../../_static/documentation_options.js?v=a5603611"></script>
598598
<script src="../../_static/doctools.js?v=888ff710"></script>
599-
<script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
599+
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
600600
<script src="../../_static/scripts/furo.js?v=7660844c"></script>
601601

602602
<script>

0 commit comments

Comments
 (0)