Deploying to gh-pages from @ 5ff7e32 🚀

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: 470f7f21ecf5331ec5fd90e7dcd932ed
+config: 138e75e4ccb7287a66206b47c2fde8ac
 tags: d77d1c0d9ca2f4c8421862c7c5a0d620

main/environments/default/index.html

@@ -320,7 +320,7 @@ <h2>How to use default scenarios<a class="headerlink" href="#how-to-use-default-
 <span class="n">game</span><span class="o">.</span><span class="n">load_config</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">vzd</span><span class="o">.</span><span class="n">scenarios_path</span><span class="p">,</span> <span class="s2">&quot;basic.cfg&quot;</span><span class="p">))</span> <span class="c1"># or any other scenario file</span>
 </pre></div>
 </div>
-<p>When using Gymnasium (or Gym) API the scenario can be loaded by passing the scenario id to <code class="docutils literal notranslate"><span class="pre">make</span></code> method like-this:</p>
+<p>When using Gymnasium API the scenario can be loaded by passing the scenario id to <code class="docutils literal notranslate"><span class="pre">make</span></code> method like-this:</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">gymnasium</span>
 <span class="kn">from</span> <span class="nn">vizdoom</span> <span class="kn">import</span> <span class="n">gymnasium_wrapper</span> <span class="c1"># This import will register all the environments</span>
 

main/genindex/index.html

@@ -354,7 +354,7 @@ <h2>C</h2>
         <li><a href="../api/python/doom_game/#vizdoom.DoomGame.close">close() (in module vizdoom.DoomGame)</a>
 
         <ul>
-          <li><a href="../api/python/gym/#vizdoom.gym_wrapper.base_gym_env.VizdoomEnv.close">(VizdoomEnv method)</a>, <a href="../api/python/gymnasium/#vizdoom.gymnasium_wrapper.base_gymnasium_env.VizdoomEnv.close">[1]</a>
+          <li><a href="../api/python/gymnasium/#vizdoom.gymnasium_wrapper.base_gymnasium_env.VizdoomEnv.close">(VizdoomEnv method)</a>
 </li>
         </ul></li>
     </ul></td>
@@ -657,13 +657,13 @@ <h2>P</h2>
   <h2>R</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
     <td style="width: 33%; vertical-align: top;"><ul>
-        <li><a href="../api/python/gym/#vizdoom.gym_wrapper.base_gym_env.VizdoomEnv.render">render() (VizdoomEnv method)</a>, <a href="../api/python/gymnasium/#vizdoom.gymnasium_wrapper.base_gymnasium_env.VizdoomEnv.render">[1]</a>
+        <li><a href="../api/python/gymnasium/#vizdoom.gymnasium_wrapper.base_gymnasium_env.VizdoomEnv.render">render() (VizdoomEnv method)</a>
 </li>
         <li><a href="../api/python/doom_game/#vizdoom.DoomGame.replay_episode">replay_episode() (in module vizdoom.DoomGame)</a>
 </li>
     </ul></td>
     <td style="width: 33%; vertical-align: top;"><ul>
-        <li><a href="../api/python/gym/#vizdoom.gym_wrapper.base_gym_env.VizdoomEnv.reset">reset() (VizdoomEnv method)</a>, <a href="../api/python/gymnasium/#vizdoom.gymnasium_wrapper.base_gymnasium_env.VizdoomEnv.reset">[1]</a>
+        <li><a href="../api/python/gymnasium/#vizdoom.gymnasium_wrapper.base_gymnasium_env.VizdoomEnv.reset">reset() (VizdoomEnv method)</a>
 </li>
         <li><a href="../api/python/doom_game/#vizdoom.DoomGame.respawn_player">respawn_player() (in module vizdoom.DoomGame)</a>
 </li>
@@ -793,7 +793,7 @@ <h2>S</h2>
 </li>
         <li><a href="../api/python/exceptions/#vizdoom.SignalException">SignalException</a>
 </li>
-        <li><a href="../api/python/gym/#vizdoom.gym_wrapper.base_gym_env.VizdoomEnv.step">step() (VizdoomEnv method)</a>, <a href="../api/python/gymnasium/#vizdoom.gymnasium_wrapper.base_gymnasium_env.VizdoomEnv.step">[1]</a>
+        <li><a href="../api/python/gymnasium/#vizdoom.gymnasium_wrapper.base_gymnasium_env.VizdoomEnv.step">step() (VizdoomEnv method)</a>
 </li>
     </ul></td>
   </tr></table>
@@ -827,12 +827,8 @@ <h2>V</h2>
 </li>
     </ul></td>
     <td style="width: 33%; vertical-align: top;"><ul>
-        <li><a href="../api/python/gym/#vizdoom.gym_wrapper.base_gym_env.VizdoomEnv">VizdoomEnv (class in vizdoom.gym_wrapper.base_gym_env)</a>
-
-        <ul>
-          <li><a href="../api/python/gymnasium/#vizdoom.gymnasium_wrapper.base_gymnasium_env.VizdoomEnv">(class in vizdoom.gymnasium_wrapper.base_gymnasium_env)</a>
+        <li><a href="../api/python/gymnasium/#vizdoom.gymnasium_wrapper.base_gymnasium_env.VizdoomEnv">VizdoomEnv (class in vizdoom.gymnasium_wrapper.base_gymnasium_env)</a>
 </li>
-        </ul></li>
         <li><a href="../api/python/exceptions/#vizdoom.ViZDoomErrorException">ViZDoomErrorException</a>
 </li>
         <li><a href="../api/python/exceptions/#vizdoom.ViZDoomIsNotRunningException">ViZDoomIsNotRunningException</a>

main/introduction/apis_and_wrappers/index.html

@@ -338,29 +338,21 @@ <h2>Gymnasium wrappers<a class="headerlink" href="#gymnasium-wrappers" title="Li
 <p>See the following examples for use:</p>
 <ul class="simple">
 <li><p><a class="reference external" href="https://github.com/Farama-Foundation/ViZDoom/tree/master/examples/python/gymnasium_wrapper.py">examples/python/gymnasium_wrapper.py</a> for basic usage</p></li>
-<li><p><a class="reference external" href="https://github.com/Farama-Foundation/ViZDoom/tree/master/examples/python/learning_stable_baselines.py">examples/python/learning_stable_baselines.py</a> for example training with <a class="reference external" href="https://github.com/DLR-RM/stable-baselines3/">stable-baselines3</a> (Update - Currently facing issues, to be fixed)</p></li>
+<li><p><a class="reference external" href="https://github.com/Farama-Foundation/ViZDoom/tree/master/examples/python/learning_stable_baselines.py">examples/python/learning_stable_baselines.py</a> for example training with <a class="reference external" href="https://github.com/DLR-RM/stable-baselines3/">stable-baselines3</a>.</p></li>
 </ul>
 </section>
 <section id="openai-gym-wrappers">
 <h2>OpenAI Gym wrappers<a class="headerlink" href="#openai-gym-wrappers" title="Link to this heading">¶</a></h2>
 <blockquote>
-<div><p>Gym is deprecated in favor of Gymnasium and these wrappers will be removed in the future.</p>
+<div><p>Original OpenAI Gym wrappers are no longer maintained and were removed from master branch. We recommend using Gymnasium wrappers instead.</p>
 </div></blockquote>
-<p>Installing ViZDoom with <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">vizdoom[gym]</span></code> will include
-Gym wrappers to interact with ViZDoom over Gym API.</p>
-<p>These wrappers are under <code class="docutils literal notranslate"><span class="pre">gym_wrappers</span></code>, containing the basic environment and
-a few example environments based on the built-in scenarios. This environment
-simply initializes ViZDoom with the settings from the scenario config files
-and implements the necessary API to function as a Gym API.</p>
-<p>See the following examples for use:</p>
-<ul class="simple">
-<li><p><a class="reference external" href="https://github.com/Farama-Foundation/ViZDoom/tree/master/examples/python/gym_wrapper.py">examples/python/gym_wrapper.py</a> for basic usage</p></li>
-</ul>
+<p>Installing ViZDoom version &lt; 1.3.0 with <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">vizdoom[gym]</span></code> will include
+Gym 0.26 wrappers to interact with ViZDoom over Gym API.</p>
 </section>
 <section id="julia-lua-and-java-apis">
 <h2>Julia, Lua, and Java APIs<a class="headerlink" href="#julia-lua-and-java-apis" title="Link to this heading">¶</a></h2>
 <blockquote>
-<div><p>Julia, Lua, and Java bindings are no longer maintained.</p>
+<div><p>Julia, Lua, and Java bindings are no longer maintained and were removed from master branch</p>
 </div></blockquote>
 <p>Julia, Lua, and Java can be found in <a class="reference external" href="https://github.com/Farama-Foundation/ViZDoom/tree/julia">julia</a> and <a class="reference external" href="https://github.com/Farama-Foundation/ViZDoom/tree/java%26lua">java&amp;lua</a> branches for manual building.</p>
 </section>

main/introduction/building/index.html

@@ -310,7 +310,7 @@
             <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.md"><span class="xref myst">Python quick start</span></a>.</p>
+If you want to install pre-build ViZDoom wheels for Python, see <a class="reference internal" href="../python_quickstart/"><span class="std std-doc">Python quick start</span></a>.</p>
 <section id="dependencies">
 <h2>Dependencies<a class="headerlink" href="#dependencies" title="Link to this heading">¶</a></h2>
 <p>To build ViZDoom (regardless of the method), you need to install some dependencies in your system first.</p>

main/introduction/python_quickstart/index.html

@@ -368,14 +368,19 @@ <h3>Installing master branch version<a class="headerlink" href="#installing-mast
 <section id="macos">
 <h2>macOS<a class="headerlink" href="#macos" title="Link to this heading">¶</a></h2>
 <p>To install the latest release of ViZDoom, just run (it may take a few minutes as it will build ViZDoom from source on M1/M2 chips):</p>
+<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>vizdoom
+</pre></div>
+</div>
+<p>Both Intel and Apple Silicon CPUs are supported.
+Pre-build wheels are available for Intel macOS 12.0+ and Apple Silicon macOS 14.0+.</p>
+<p>If Python wheel is not available for your platform (Python version &lt;3.8, older macOS version), pip will try to install (build) ViZDoom from the source.
+In this case, install the required dependencies using Homebrew:</p>
 <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>brew<span class="w"> </span>install<span class="w"> </span>cmake<span class="w"> </span>boost<span class="w"> </span>sdl2<span class="w"> </span>openal-soft
-pip<span class="w"> </span>install<span class="w"> </span>vizdoom
 </pre></div>
 </div>
-<p>Both Intel and Apple Silicon (M1/2/3) CPUs are supported.
-We recommend using at least macOS High Sierra 10.13+ with Python 3.8+.
-On Apple Silicon, make sure you are using Python/Pip for Apple Silicon.</p>
-<p>To install the master branch version of ViZDoom, run:</p>
+<p>We recommend using at least macOS High Sierra 10.13+ with Python 3.8+.
+On Apple Silicon (M1, M2, and M3), make sure you are using Python/Pip for Apple Silicon.</p>
+<p>To install the master branch version of ViZDoom, run, in this case you also need to have the above dependencies installed:</p>
 <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>git+https://github.com/Farama-Foundation/ViZDoom
 </pre></div>
 </div>
@@ -387,10 +392,10 @@ <h2>Windows<a class="headerlink" href="#windows" title="Link to this heading">¶
 </pre></div>
 </div>
 <p>At the moment, only x86-64 architecture is supported on Windows.
-Wheels are available for Python 3.8+ x86-64 on Windows.</p>
+Wheels are available for Python 3.9+ x86-64 on Windows.</p>
 <p>Please note that the Windows version is not as well-tested as Linux and macOS versions.
 It can be used for development and testing but if you want to conduct serious (time and resource-extensive) experiments on Windows,
-please consider using <a class="reference external" href="https://docs.docker.com/docker-for-windows/install/">Docker</a> or <a class="reference external" href="https://docs.microsoft.com/en-us/windows/wsl/install-win10">WSL</a> with Linux version.
+please consider using <a class="reference external" href="https://docs.docker.com/docker-for-windows/install/">Docker</a> or <a class="reference external" href="https://docs.microsoft.com/en-us/windows/wsl">WSL</a> with Linux version.
 Windows version is bundled with OpenAL library, so you don’t need to install it separately.</p>
 </section>
 </section>