Deploying to gh-pages from @ 2a073fc 🚀

Author: mwydmuch

main/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 0fd9a0b0eb63acd912235c177da67b30
+config: 29b2474a9a1ba61cef4c763f635bf41a
 tags: d77d1c0d9ca2f4c8421862c7c5a0d620

main/404.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="page-not-found">
+            <section class="tex2jax_ignore mathjax_ignore" id="page-not-found">
 <h1>404 - Page Not Found<a class="headerlink" href="#page-not-found" title="Link to this heading">#</a></h1>
 <section id="the-requested-page-could-not-be-found">
 <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>

main/README/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="vizdoom-documentation">
+            <section class="tex2jax_ignore mathjax_ignore" id="vizdoom-documentation">
 <h1>ViZDoom documentation<a class="headerlink" href="#vizdoom-documentation" title="Link to this heading">#</a></h1>
 <p>This directory contains the documentation for ViZDOOm.</p>
 <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>

main/api/configurationFiles/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="configuration-files">
+            <section class="tex2jax_ignore mathjax_ignore" id="configuration-files">
 <h1>Configuration files<a class="headerlink" href="#configuration-files" title="Link to this heading">#</a></h1>
 <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>
 <section id="format">

main/api/cpp/doomGame/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="doomgame">
+            <section class="tex2jax_ignore mathjax_ignore" id="doomgame">
 <h1>DoomGame<a class="headerlink" href="#doomgame" title="Link to this heading">#</a></h1>
 <p>DoomGame is the main object of the ViZDoom library, representing a single instance of the Doom game and providing the interface for a single agent/player to interact with the game. The object allows sending actions to the game, getting the game state, etc. The declarations of this class and its methods can be found in the <code class="docutils literal notranslate"><span class="pre">include/ViZDoomGame.h</span></code> header file.</p>
 <p>Here we document all the methods of the DoomGame class and their corresponding Python bindings implemented as pybind11 module.</p>

main/api/cpp/enums/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="enums">
+            <section class="tex2jax_ignore mathjax_ignore" id="enums">
 <h1>Enums<a class="headerlink" href="#enums" title="Link to this heading">#</a></h1>
 <p>ViZDoom is using few types of enums as parameters for its functions. Below you can find the description of all of them.
 The declarations of all the enums can be found in the <code class="docutils literal notranslate"><span class="pre">include/ViZDoomTypes.h</span></code> header file.</p>

main/api/cpp/exceptions/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="exceptions">
+            <section class="tex2jax_ignore mathjax_ignore" id="exceptions">
 <h1>Exceptions<a class="headerlink" href="#exceptions" title="Link to this heading">#</a></h1>
 <p>ViZDoom defines several exceptions that can be thrown by its API:
 Most of the exceptions contain more information in “what()” message.

main/api/cpp/gameState/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="gamestate">
+            <section class="tex2jax_ignore mathjax_ignore" id="gamestate">
 <h1>GameState<a class="headerlink" href="#gamestate" title="Link to this heading">#</a></h1>
 <p>GameState is the main object returned by <a class="reference internal" href="../doomGame/#getstate"><span class="std std-ref"><code class="docutils literal notranslate"><span class="pre">DoomGame:</span> <span class="pre">getState</span></code></span></a> method.
 The declarations of all the enums can be found in the <code class="docutils literal notranslate"><span class="pre">include/ViZDoomTypes.h</span></code> header file.</p>

main/api/cpp/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="c-api">
+            <section class="tex2jax_ignore mathjax_ignore" id="c-api">
 <h1>C++ API<a class="headerlink" href="#c-api" title="Link to this heading">#</a></h1>
 <p>ViZDoom is implemented in C++ and can be used as a C++ library. The C++ API is one-to-one with the Python API. The only difference is the use of <code class="docutils literal notranslate"><span class="pre">camelCase</span></code> instead of <code class="docutils literal notranslate"><span class="pre">snake_case</span></code> for method names.</p>
 <p>ViZDoom can be built as a static or dynamic library. The header files are located in the <code class="docutils literal notranslate"><span class="pre">include</span></code> directory.

main/api/cpp/utils/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="utilities">
+            <section class="tex2jax_ignore mathjax_ignore" id="utilities">
 <h1>Utilities<a class="headerlink" href="#utilities" title="Link to this heading">#</a></h1>
 <p>Here we document the helpers functions that are not part of any object.
 They mostly help to deal with conversion of Doom’s engine types.

main/api/python/doomGame/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="doomgame">
+            <section class="tex2jax_ignore mathjax_ignore" id="doomgame">
 <h1>DoomGame<a class="headerlink" href="#doomgame" title="Link to this heading">#</a></h1>
 <p>DoomGame is the main object of the ViZDoom library, representing a single instance of the Doom game and providing the interface for a single agent/player to interact with the game. The object allows sending actions to the game, getting the game state, etc.</p>
 <dl class="py class">

main/api/python/enums/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="enums">
+            <section class="tex2jax_ignore mathjax_ignore" id="enums">
 <h1>Enums<a class="headerlink" href="#enums" title="Link to this heading">#</a></h1>
 <p>ViZDoom is using few types of enums as parameters for its functions.</p>
 <dl class="py class">

main/api/python/exceptions/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="exceptions">
+            <section class="tex2jax_ignore mathjax_ignore" id="exceptions">
 <h1>Exceptions<a class="headerlink" href="#exceptions" title="Link to this heading">#</a></h1>
 <p>ViZDoom defines several exceptions that can be thrown by its API.
 Most of the exceptions contain more information in the exception’s message.</p>

main/api/python/gameState/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="gamestate">
+            <section class="tex2jax_ignore mathjax_ignore" id="gamestate">
 <h1>GameState<a class="headerlink" href="#gamestate" title="Link to this heading">#</a></h1>
 <dl class="py class">
 <dt class="sig sig-object py" id="vizdoom.GameState">

main/api/python/gym/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="openai-gym-env">
+            <section class="tex2jax_ignore mathjax_ignore" id="openai-gym-env">
 <h1>OpenAI Gym Env<a class="headerlink" href="#openai-gym-env" title="Link to this heading">#</a></h1>
 <blockquote>
 <div><p>Gym is deprecated in favor of Gymnasium and these wrappers will be removed in the future.</p>

main/api/python/gymnasium/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="gymnasium-env">
+            <section class="tex2jax_ignore mathjax_ignore" id="gymnasium-env">
 <h1>Gymnasium Env<a class="headerlink" href="#gymnasium-env" title="Link to this heading">#</a></h1>
 <dl class="py class">
 <dt class="sig sig-object py" id="vizdoom.gymnasium_wrapper.base_gymnasium_env.VizdoomEnv">

main/api/python/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="python-api">
+            <section class="tex2jax_ignore mathjax_ignore" id="python-api">
 <h1>Python API<a class="headerlink" href="#python-api" title="Link to this heading">#</a></h1>
 <p>ViZDoom provides Python bindings for the library. The Python API is one-to-one with the C++ API. The only difference is the use of <code class="docutils literal notranslate"><span class="pre">snake_case</span></code> instead of <code class="docutils literal notranslate"><span class="pre">camelCase</span></code> for method and argument names.</p>
 <p>There are many examples of how to use Python API in <a class="reference external" href="https://github.com/Farama-Foundation/ViZDoom/tree/master/examples/python">examples/python</a> directory.</p>

main/api/python/utils/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="utilities">
+            <section class="tex2jax_ignore mathjax_ignore" id="utilities">
 <h1>Utilities<a class="headerlink" href="#utilities" title="Link to this heading">#</a></h1>
 <p>Here we document the helpers functions that are not part of any object.
 They mostly help to deal with conversion of Doom’s engine types.</p>

main/citation/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="how-to-cite">
+            <section class="tex2jax_ignore mathjax_ignore" id="how-to-cite">
 <h1>How to cite<a class="headerlink" href="#how-to-cite" title="Link to this heading">#</a></h1>
 <p>If you use or reference to ViZDoom library in your publications, please cite the following papers:</p>
 <blockquote>

main/environments/creatingCustom/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="creating-a-custom-environment">
+            <section class="tex2jax_ignore mathjax_ignore" id="creating-a-custom-environment">
 <h1>Creating a custom environment<a class="headerlink" href="#creating-a-custom-environment" title="Link to this heading">#</a></h1>
 <p>ViZDoom allows the use of custom scenarios/environments that can be easily prepared using modern Doom map editors like <a class="reference external" href="http://slade.mancubus.net/index.php?page=downloads">SLADE</a> (available for Linux, MacOS, and Windows) or <a class="reference external" href="http://www.doombuilder.com/index.php?p=downloads">DoomBuilder</a> (a bit better editor, but only available for Windows), that we recommend using. These editors allow you to create a map used by the environment and program custom logic and rewards using ACS scripting language. In addition to a map+script created in one of the editors that is saved to a .wad file, ViZDoom uses .cfg config files that store additional information about the environment. Such .wad and .cfg together define a custom environment that can be used with ViZDoom. The following will guide you through the process of creating a custom environment.</p>
 <section id="limitations-and-possibilities">

main/environments/default/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="default-scenarios-environments">
+            <section class="tex2jax_ignore mathjax_ignore" id="default-scenarios-environments">
 <h1>Default scenarios/environments<a class="headerlink" href="#default-scenarios-environments" title="Link to this heading">#</a></h1>
 <p>Below we describe a default singleplayer scenarios (original ViZDoom nomenclature)/environments (Gymnasium/Open AI Gym nomenclature) included with ViZDoom. The PRs with new scenarios are welcome!</p>
 <section id="how-to-use-default-scenarios">

main/faq/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="faq">
+            <section class="tex2jax_ignore mathjax_ignore" id="faq">
 <h1>FAQ<a class="headerlink" href="#faq" title="Link to this heading">#</a></h1>
 <p>This file contains a list of questions that ViZDoom users may ask at some point.
 You can find more questions and answers by searching for issues with “question” tag

main/introduction/apisAndWrappers/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="apis-and-wrappers">
+            <section class="tex2jax_ignore mathjax_ignore" id="apis-and-wrappers">
 <h1>APIs and wrappers<a class="headerlink" href="#apis-and-wrappers" title="Link to this heading">#</a></h1>
 <p>ViZDoom consists of a few APIs: C++ API, Python API that is a wrapper around C++ API, and Gymnasium/Gym wrappers that wrap around Python API to allow the use of ViZDoom scenarios as Gymnasium/Gym environments.</p>
 <p>Because ViZDoom was created before the first release of OpenAI Gym, it uses a bit different nomenclature in its API than Gym/Gymnasium:</p>

main/introduction/building/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="building-from-source">
+            <section class="tex2jax_ignore mathjax_ignore" id="building-from-source">
 <h1>Building from source<a class="headerlink" href="#building-from-source" title="Link to this heading">#</a></h1>
 <p>Here we describe how to build ViZDoom from source.
 If you want to install pre-build ViZDoom wheels for Python, see <a class="reference internal" href="../pythonQuickstart/"><span class="std std-doc">Python quick start</span></a>.</p>

main/introduction/pythonQuickstart/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="python-quick-start">
+            <section class="tex2jax_ignore mathjax_ignore" id="python-quick-start">
 <h1>Python quick start<a class="headerlink" href="#python-quick-start" title="Link to this heading">#</a></h1>
 <section id="linux">
 <h2>Linux<a class="headerlink" href="#linux" title="Link to this heading">#</a></h2>

main/release_notes/index.html

@@ -310,7 +310,7 @@
           </div>
           <article role="main">
 
-            <section id="release-notes">
+            <section class="tex2jax_ignore mathjax_ignore" id="release-notes">
 <h1>Release Notes<a class="headerlink" href="#release-notes" title="Link to this heading">#</a></h1>
 <section id="release-1-2-2">
 <h2>ViZDoom 1.2.2: Fix for Python source distribution missing pybind11, fix manual building<a class="headerlink" href="#release-1-2-2" title="Link to this heading">#</a></h2>