Skip to content

Commit

Permalink
Deploying to gh-pages from @ 52b399a 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
MatPoliquin committed Jan 8, 2025
1 parent 5f738e1 commit ef0ba26
Show file tree
Hide file tree
Showing 18 changed files with 329 additions and 329 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: 9f2d9ecbbb04a7c2c05f0937a5677300
config: f891883950377f1f4066af662159a6e2
tags: d77d1c0d9ca2f4c8421862c7c5a0d620
4 changes: 2 additions & 2 deletions main/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@

<!-- Generated with Sphinx 7.4.7 and Furo 2023.08.19.dev1 -->
<title>404 - Page Not Found - Stable-Retro Documentation</title>
<link rel="stylesheet" type="text/css" href="/_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="/_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="/_static/styles/furo.css?v=3e7f4c72" />
<link rel="stylesheet" type="text/css" href="/_static/styles/furo-extensions.css?v=49cbaffd" />
<link rel="stylesheet" type="text/css" href="/_static/styles/furo-extensions.css?v=82c8b628" />



Expand Down
4 changes: 2 additions & 2 deletions main/README/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@

<!-- Generated with Sphinx 7.4.7 and Furo 2023.08.19.dev1 -->
<title>Stable-retro docs - Stable-Retro Documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=3e7f4c72" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=49cbaffd" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=82c8b628" />



Expand Down
4 changes: 2 additions & 2 deletions main/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@

<!-- Generated with Sphinx 7.4.7 and Furo 2023.08.19.dev1 -->
<title>Overview: module code - Stable-Retro Documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=3e7f4c72" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=49cbaffd" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=82c8b628" />



Expand Down
12 changes: 6 additions & 6 deletions main/_modules/retro/enums/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@

<!-- Generated with Sphinx 7.4.7 and Furo 2023.08.19.dev1 -->
<title>retro.enums - Stable-Retro Documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=3e7f4c72" />
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=49cbaffd" />
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=82c8b628" />



Expand Down Expand Up @@ -269,12 +269,12 @@
<article role="main">

<h1>Source code for retro.enums</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span>
<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">enum</span><span class="w"> </span><span class="kn">import</span> <span class="n">Enum</span>


<div class="viewcode-block" id="State">
<a class="viewcode-back" href="../../../python/#retro.State">[docs]</a>
<span class="k">class</span> <span class="nc">State</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
<span class="k">class</span><span class="w"> </span><span class="nc">State</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Special values for setting the restart state of the environment. You can</span>
<span class="sd"> also specify a string that is the name of the ``.state`` file</span>
Expand All @@ -287,7 +287,7 @@ <h1>Source code for retro.enums</h1><div class="highlight"><pre>

<div class="viewcode-block" id="Observations">
<a class="viewcode-back" href="../../../python/#retro.Observations">[docs]</a>
<span class="k">class</span> <span class="nc">Observations</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
<span class="k">class</span><span class="w"> </span><span class="nc">Observations</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Different settings for the observation space of the environment</span>
<span class="sd"> &quot;&quot;&quot;</span>
Expand All @@ -299,7 +299,7 @@ <h1>Source code for retro.enums</h1><div class="highlight"><pre>

<div class="viewcode-block" id="Actions">
<a class="viewcode-back" href="../../../python/#retro.Actions">[docs]</a>
<span class="k">class</span> <span class="nc">Actions</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
<span class="k">class</span><span class="w"> </span><span class="nc">Actions</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Different settings for the action space of the environment</span>
<span class="sd"> &quot;&quot;&quot;</span>
Expand Down
26 changes: 13 additions & 13 deletions main/_modules/retro/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@

<!-- Generated with Sphinx 7.4.7 and Furo 2023.08.19.dev1 -->
<title>retro - Stable-Retro Documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=3e7f4c72" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=49cbaffd" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=82c8b628" />



Expand Down Expand Up @@ -269,13 +269,13 @@
<article role="main">

<h1>Source code for retro</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span></span><span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>

<span class="kn">import</span> <span class="nn">retro.data</span>
<span class="kn">from</span> <span class="nn">retro._retro</span> <span class="kn">import</span> <span class="n">Movie</span><span class="p">,</span> <span class="n">RetroEmulator</span><span class="p">,</span> <span class="n">core_path</span>
<span class="kn">from</span> <span class="nn">retro.enums</span> <span class="kn">import</span> <span class="n">Actions</span><span class="p">,</span> <span class="n">Observations</span><span class="p">,</span> <span class="n">State</span>
<span class="kn">from</span> <span class="nn">retro.retro_env</span> <span class="kn">import</span> <span class="n">RetroEnv</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">retro.data</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">retro._retro</span><span class="w"> </span><span class="kn">import</span> <span class="n">Movie</span><span class="p">,</span> <span class="n">RetroEmulator</span><span class="p">,</span> <span class="n">core_path</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">retro.enums</span><span class="w"> </span><span class="kn">import</span> <span class="n">Actions</span><span class="p">,</span> <span class="n">Observations</span><span class="p">,</span> <span class="n">State</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">retro.retro_env</span><span class="w"> </span><span class="kn">import</span> <span class="n">RetroEnv</span>

<span class="n">ROOT_DIR</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</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">dirname</span><span class="p">(</span><span class="vm">__file__</span><span class="p">))</span>
<span class="n">core_path</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">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="vm">__file__</span><span class="p">),</span> <span class="s2">&quot;cores&quot;</span><span class="p">))</span>
Expand All @@ -300,19 +300,19 @@ <h1>Source code for retro</h1><div class="highlight"><pre>
<span class="n">retro</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">init_core_info</span><span class="p">(</span><span class="n">core_path</span><span class="p">())</span>


<span class="k">def</span> <span class="nf">get_core_path</span><span class="p">(</span><span class="n">corename</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">get_core_path</span><span class="p">(</span><span class="n">corename</span><span class="p">):</span>
<span class="k">return</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">core_path</span><span class="p">(),</span> <span class="n">retro</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">EMU_CORES</span><span class="p">[</span><span class="n">corename</span><span class="p">])</span>


<span class="k">def</span> <span class="nf">get_romfile_system</span><span class="p">(</span><span class="n">rom_path</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">get_romfile_system</span><span class="p">(</span><span class="n">rom_path</span><span class="p">):</span>
<span class="n">extension</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">splitext</span><span class="p">(</span><span class="n">rom_path</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">if</span> <span class="n">extension</span> <span class="ow">in</span> <span class="n">retro</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">EMU_EXTENSIONS</span><span class="p">:</span>
<span class="k">return</span> <span class="n">retro</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">EMU_EXTENSIONS</span><span class="p">[</span><span class="n">extension</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Unsupported rom type at path: </span><span class="si">{</span><span class="n">rom_path</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>


<span class="k">def</span> <span class="nf">get_system_info</span><span class="p">(</span><span class="n">system</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">get_system_info</span><span class="p">(</span><span class="n">system</span><span class="p">):</span>
<span class="k">if</span> <span class="n">system</span> <span class="ow">in</span> <span class="n">retro</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">EMU_INFO</span><span class="p">:</span>
<span class="k">return</span> <span class="n">retro</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">EMU_INFO</span><span class="p">[</span><span class="n">system</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
Expand All @@ -321,7 +321,7 @@ <h1>Source code for retro</h1><div class="highlight"><pre>

<div class="viewcode-block" id="make">
<a class="viewcode-back" href="../../python/#retro.make">[docs]</a>
<span class="k">def</span> <span class="nf">make</span><span class="p">(</span><span class="n">game</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="n">State</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">inttype</span><span class="o">=</span><span class="n">retro</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">Integrations</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">make</span><span class="p">(</span><span class="n">game</span><span class="p">,</span> <span class="n">state</span><span class="o">=</span><span class="n">State</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">inttype</span><span class="o">=</span><span class="n">retro</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">Integrations</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Create a Gym environment for the specified game</span>
<span class="sd"> &quot;&quot;&quot;</span>
Expand All @@ -339,7 +339,7 @@ <h1>Source code for retro</h1><div class="highlight"><pre>


<span class="k">try</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">farama_notifications</span> <span class="kn">import</span> <span class="n">notifications</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">farama_notifications</span><span class="w"> </span><span class="kn">import</span> <span class="n">notifications</span>

<span class="k">if</span> <span class="s2">&quot;stable-retro&quot;</span> <span class="ow">in</span> <span class="n">notifications</span> <span class="ow">and</span> <span class="n">__version__</span> <span class="ow">in</span> <span class="n">notifications</span><span class="p">[</span><span class="s2">&quot;stable-retro&quot;</span><span class="p">]:</span>
<span class="nb">print</span><span class="p">(</span><span class="n">notifications</span><span class="p">[</span><span class="s2">&quot;stable-retro&quot;</span><span class="p">][</span><span class="n">__version__</span><span class="p">],</span> <span class="n">file</span><span class="o">=</span><span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="p">)</span>
Expand Down
Loading

0 comments on commit ef0ba26

Please sign in to comment.