Skip to content

Commit

Permalink
Deploying to gh-pages from @ 527a934 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
mwydmuch committed Dec 12, 2023
1 parent 82a559d commit e5421c3
Show file tree
Hide file tree
Showing 9 changed files with 150 additions and 57 deletions.
2 changes: 1 addition & 1 deletion main/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: 92b1e150a88b13e8f7807185235c13cc
config: 0fd9a0b0eb63acd912235c177da67b30
tags: d77d1c0d9ca2f4c8421862c7c5a0d620
67 changes: 44 additions & 23 deletions main/api/cpp/doomGame/index.html

Large diffs are not rendered by default.

114 changes: 91 additions & 23 deletions main/api/python/doomGame/index.html

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions main/api/python/utils/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -360,12 +360,14 @@ <h2>Button functions<a class="headerlink" href="#button-functions" title="Link t
<dt class="sig sig-object py" id="vizdoom.is_binary_button">
<span class="sig-name descname"><span class="pre">is_binary_button</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">button</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enums/#vizdoom.Button" title="vizdoom.Button"><span class="pre">vizdoom.Button</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#vizdoom.is_binary_button" title="Link to this definition">#</a></dt>
<dd><p>Returns True if button is binary button.</p>
<p>See also:</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="vizdoom.is_delta_button">
<span class="sig-name descname"><span class="pre">is_delta_button</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">button</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enums/#vizdoom.Button" title="vizdoom.Button"><span class="pre">vizdoom.Button</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#vizdoom.is_delta_button" title="Link to this definition">#</a></dt>
<dd><p>Returns True if button is delta button.</p>
<p>See also:</p>
</dd></dl>

</section>
Expand Down
2 changes: 2 additions & 0 deletions main/genindex/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,8 @@ <h2>G</h2>
<li><a href="../api/python/doomGame/#vizdoom.DoomGame.get_episode_time">get_episode_time() (in module vizdoom.DoomGame)</a>
</li>
<li><a href="../api/python/doomGame/#vizdoom.DoomGame.get_episode_timeout">get_episode_timeout() (in module vizdoom.DoomGame)</a>
</li>
<li><a href="../api/python/doomGame/#vizdoom.DoomGame.get_game_args">get_game_args() (in module vizdoom.DoomGame)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
Expand Down
4 changes: 2 additions & 2 deletions main/introduction/building/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -475,12 +475,12 @@ <h3>Compilation output<a class="headerlink" href="#compilation-output" title="Li
<li><p><code class="docutils literal notranslate"><span class="pre">bin/libvizdoom.a</span> <span class="pre">/</span> <span class="pre">vizdoom.lib</span></code> - C++ ViZDoom static library</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">bin/libvizdoom.so</span> <span class="pre">/</span> <span class="pre">vizdoom.dll</span> <span class="pre">/</span> <span class="pre">libvizdoom.dylib</span></code> - C++ ViZDoom dynamically linked library</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">bin/pythonX.X/vizdoom.so</span> <span class="pre">/</span> <span class="pre">vizdoom.pyd</span> <span class="pre">/</span> <span class="pre">vizdoom.dylib</span> </code> - ViZDoom Python X.X module</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">bin/pythonX.X/pip_package</span></code> - complete ViZDoom Python X.X package</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">bin/pythonX.X/vizdoom</span></code> - complete ViZDoom Python X.X package</p></li>
</ul>
</section>
<section id="manual-installation">
<h3>Manual installation<a class="headerlink" href="#manual-installation" title="Link to this heading">#</a></h3>
<p>To manually install Python package copy <code class="docutils literal notranslate"><span class="pre">vizdoom_root_dir/build/bin/pythonX.X/pip_package</span></code> contents to <code class="docutils literal notranslate"><span class="pre">python_root_dir/lib/pythonX.X/site-packages/site-packages/vizdoom</span></code>.</p>
<p>To manually install Python package copy <code class="docutils literal notranslate"><span class="pre">vizdoom_root_dir/build/bin/pythonX.X/vizdoom</span></code> contents to <code class="docutils literal notranslate"><span class="pre">python_root_dir/lib/pythonX.X/site-packages/site-packages/vizdoom</span></code>.</p>
</section>
</section>
</section>
Expand Down
14 changes: 7 additions & 7 deletions main/introduction/pythonQuickstart/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -320,8 +320,8 @@ <h2>Linux<a class="headerlink" href="#linux" title="Link to this heading">#</a><
</div>
<p>Both x86-64 and AArch64 (ARM64) architectures are supported.
Wheels are available for Python 3.8+ on Linux.</p>
<p>If Python wheel is not available for your platform (Python version &lt;3.8, distros below manylinux_2_28 standard), pip will try to install (build) ViZDoom from the source.
ViZDoom requires a C++11 compiler, CMake 3.12+, Boost 1.54+ SDL2, OpenAL (optional), and Python 3.7+ to install from source. Below, you will find instructions on how to install these dependencies.</p>
<p>If Python wheel is not available for your platform (distros incompatible with manylinux_2_28 standard), pip will try to install (build) ViZDoom from the source.
ViZDoom requires a C++11 compiler, CMake 3.12+, Boost 1.54+ SDL2, OpenAL (optional), and Python 3.8+ to install from source. Below, you will find instructions on how to install these dependencies.</p>
<section id="apt-based-distros-ubuntu-debian-linux-mint-etc">
<h3>apt-based distros (Ubuntu, Debian, Linux Mint, etc.)<a class="headerlink" href="#apt-based-distros-ubuntu-debian-linux-mint-etc" title="Link to this heading">#</a></h3>
<p>To build ViZDoom run (it may take a few minutes):</p>
Expand All @@ -338,7 +338,7 @@ <h3>dnf/yum-based distros (Fedora, RHEL, CentOS, Alma/Rocky Linux, etc.)<a class
pip<span class="w"> </span>install<span class="w"> </span>vizdoom
</pre></div>
</div>
<p>We recommend using at least Fedora 35+ or RHEL/CentOS/Alma/Rocky Linux 9+ with Python 3.7+.
<p>We recommend using at least Fedora 35+ or RHEL/CentOS/Alma/Rocky Linux 9+ with Python 3.8+.
To install openal-soft-devel on RHEL/CentOS/Alma/Rocky Linux 9, one needs to use <code class="docutils literal notranslate"><span class="pre">dnf</span> <span class="pre">--enablerepo=crb</span> <span class="pre">install</span></code>.</p>
</section>
<section id="master-branch-version">
Expand All @@ -356,9 +356,9 @@ <h2>macOS<a class="headerlink" href="#macos" title="Link to this heading">#</a><
pip<span class="w"> </span>install<span class="w"> </span>vizdoom
</pre></div>
</div>
<p>Both Intel and Apple Silicon CPUs are supported.
We recommend using at least macOS High Sierra 10.13+ with Python 3.7+.
On Apple Silicon (M1 and M2), make sure you are using Python/Pip for Apple Silicon.</p>
<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>
<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>
Expand All @@ -371,7 +371,7 @@ <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+ on Windows.</p>
Wheels are available for Python 3.8+ 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.</p>
Expand Down
Binary file modified main/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion main/searchindex.js

Large diffs are not rendered by default.

0 comments on commit e5421c3

Please sign in to comment.