Deploying to gh-pages from @ 5160731 🚀

.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: 7af374bb35ac9ad7d084e470d0b3ff04
+config: 5c2fe858f755beb9a52176ff712e03ad
 tags: d77d1c0d9ca2f4c8421862c7c5a0d620

404.html

@@ -11,11 +11,11 @@
 <link rel="index" title="Index" href="/genindex/" /><link rel="search" title="Search" href="/search/" />
         <link rel="canonical" href="https://vizdoom.farama.org/404.html" />
 
-    <link rel="shortcut icon" href="/_static/favicon.png"/><!-- Generated with Sphinx 7.0.1 and Furo 2023.05.20.dev1 -->
+    <link rel="shortcut icon" href="/_static/favicon.png"/><!-- Generated with Sphinx 7.1.2 and Furo 2023.05.20.dev1 -->
         <title>404 - Page Not Found - ViZDoom Documentation</title>
-      <link rel="stylesheet" type="text/css" href="/_static/pygments.css" />
+      <link rel="stylesheet" type="text/css" href="/_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="/_static/styles/furo.css?digest=2b6f8eb5452c44539a42dd9ada0a48f56e5f404d" />
-    <link rel="stylesheet" type="text/css" href="/_static/styles/furo-extensions.css?digest=d98e5db1aa483f10fd0a50bf79700ebb0c5bab79" />
+    <link rel="stylesheet" type="text/css" href="/_static/styles/furo-extensions.css?digest=5d0deb98f4b2e6cecaee64745957f1068f205919" />
 
 
 
@@ -214,24 +214,29 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="/introduction/pythonQuickstart/">Python quick start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="/introduction/building/">Building from source</a></li>
-<li class="toctree-l1"><a class="reference internal" href="/introduction/wrappers/">Wrapper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="/introduction/apisAndWrappers/">APIs and wrappers</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">Python API</span></p>
+<p class="caption" role="heading"><span class="caption-text">API</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="/api_python/gymnasium/">Gymnasium</a></li>
-<li class="toctree-l1"><a class="reference internal" href="/api_python/doomGame/">DoomGame</a></li>
-<li class="toctree-l1"><a class="reference internal" href="/api_python/gameState/">GameState</a></li>
-<li class="toctree-l1"><a class="reference internal" href="/api_python/enums/">Enums</a></li>
-<li class="toctree-l1"><a class="reference internal" href="/api_python/utils/">Utilities</a></li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="/api/python/">Python API</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Python API</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l2"><a class="reference internal" href="/api/python/doomGame/">DoomGame</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/api/python/gameState/">GameState</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/api/python/enums/">Enums</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/api/python/utils/">Utilities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/api/python/exceptions/">Exceptions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/api/python/gymnasium/">Gymnasium Env</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/api/python/gym/">OpenAI Gym Env</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">C++ API</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="/api_cpp/doomGame/">DoomGame</a></li>
-<li class="toctree-l1"><a class="reference internal" href="/api_cpp/gameState/">GameState</a></li>
-<li class="toctree-l1"><a class="reference internal" href="/api_cpp/enums/">Enums</a></li>
-<li class="toctree-l1"><a class="reference internal" href="/api_cpp/configurationFiles/">Configuration files</a></li>
-<li class="toctree-l1"><a class="reference internal" href="/api_cpp/exceptions/">Exceptions</a></li>
-<li class="toctree-l1"><a class="reference internal" href="/api_cpp/utils/">Utilities</a></li>
+</li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="/api/cpp/">C++ API</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of C++ API</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l2"><a class="reference internal" href="/api/cpp/doomGame/">DoomGame</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/api/cpp/gameState/">GameState</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/api/cpp/enums/">Enums</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/api/cpp/exceptions/">Exceptions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/api/cpp/utils/">Utilities</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="/api/configurationFiles/">Configuration files</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 <ul>
@@ -242,6 +247,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="/faq/">FAQ</a></li>
 <li class="toctree-l1"><a class="reference internal" href="/citation/">How to cite</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://vizdoom.cs.put.edu.pl/">Original website</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>
@@ -427,10 +433,10 @@ <h2>The requested page could not be found.<a class="headerlink" href="#the-reque
         })()
       </script>
 
-    <script data-url_root="../" id="documentation_options" src="/_static/documentation_options.js"></script>
-    <script src="/_static/doctools.js"></script>
-    <script src="/_static/sphinx_highlight.js"></script>
-    <script src="/_static/scripts/furo.js"></script>
+    <script data-url_root="../" id="documentation_options" src="/_static/documentation_options.js?v=dda0c7a7"></script>
+    <script src="/_static/doctools.js?v=888ff710"></script>
+    <script src="/_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="/_static/scripts/furo.js?v=7660844c"></script>
 
     <script>
 
@@ -560,7 +566,7 @@ <h2>The requested page could not be found.<a class="headerlink" href="#the-reque
             const subSectionContainerElem = Object.assign(
                 document.createElement('div'), {
                   className:'farama-header-menu__subsections-container',
-                  style: key == "Mature Projects" ? "display: flex" : ""
+                  style: 'display: flex'
                 }
             )
             Object.keys(subSections).forEach((subKey, i) => {
@@ -575,7 +581,7 @@ <h2>The requested page could not be found.<a class="headerlink" href="#the-reque
                   innerText: subKey
                 }
               ))
-              const ulElem = createProjectsList(subSections[subKey], key !== "Foundation");
+              const ulElem = createProjectsList(subSections[subKey], key !== 'Foundation');
               subSectionElem.appendChild(ulElem);
               subSectionContainerElem.appendChild(subSectionElem);
             })

README/index.html

@@ -11,11 +11,11 @@
 <link rel="index" title="Index" href="../genindex/" /><link rel="search" title="Search" href="../search/" />
         <link rel="canonical" href="https://vizdoom.farama.org/README.html" />
 
-    <link rel="shortcut icon" href="../_static/favicon.png"/><!-- Generated with Sphinx 7.0.1 and Furo 2023.05.20.dev1 -->
+    <link rel="shortcut icon" href="../_static/favicon.png"/><!-- Generated with Sphinx 7.1.2 and Furo 2023.05.20.dev1 -->
         <title>ViZDoom documentation - ViZDoom Documentation</title>
-      <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=2b6f8eb5452c44539a42dd9ada0a48f56e5f404d" />
-    <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=d98e5db1aa483f10fd0a50bf79700ebb0c5bab79" />
+    <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=5d0deb98f4b2e6cecaee64745957f1068f205919" />
 
 
 
@@ -214,24 +214,29 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../introduction/pythonQuickstart/">Python quick start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../introduction/building/">Building from source</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../introduction/wrappers/">Wrapper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/apisAndWrappers/">APIs and wrappers</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">Python API</span></p>
+<p class="caption" role="heading"><span class="caption-text">API</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../api_python/gymnasium/">Gymnasium</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../api_python/doomGame/">DoomGame</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../api_python/gameState/">GameState</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../api_python/enums/">Enums</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../api_python/utils/">Utilities</a></li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="../api/python/">Python API</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Python API</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/python/doomGame/">DoomGame</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/python/gameState/">GameState</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/python/enums/">Enums</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/python/utils/">Utilities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/python/exceptions/">Exceptions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/python/gymnasium/">Gymnasium Env</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/python/gym/">OpenAI Gym Env</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">C++ API</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="../api_cpp/doomGame/">DoomGame</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../api_cpp/gameState/">GameState</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../api_cpp/enums/">Enums</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../api_cpp/configurationFiles/">Configuration files</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../api_cpp/exceptions/">Exceptions</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../api_cpp/utils/">Utilities</a></li>
+</li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="../api/cpp/">C++ API</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of C++ API</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/cpp/doomGame/">DoomGame</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/cpp/gameState/">GameState</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/cpp/enums/">Enums</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/cpp/exceptions/">Exceptions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/cpp/utils/">Utilities</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../api/configurationFiles/">Configuration files</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 <ul>
@@ -242,6 +247,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../faq/">FAQ</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../citation/">How to cite</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://vizdoom.cs.put.edu.pl/">Original website</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Development</span></p>
 <ul>
@@ -308,6 +314,11 @@
 <h1>ViZDoom documentation<a class="headerlink" href="#vizdoom-documentation" title="Permalink 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>
+<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>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">scripts</span><span class="o">/</span><span class="n">create_python_docs_from_cpp_docs</span><span class="o">.</span><span class="n">py</span>
+<span class="n">python</span> <span class="n">scripts</span><span class="o">/</span><span class="n">create_python_docstrings_from_cpp_docs</span><span class="o">.</span><span class="n">py</span>
+</pre></div>
+</div>
 </section>
 
           </article>
@@ -426,10 +437,10 @@ <h1>ViZDoom documentation<a class="headerlink" href="#vizdoom-documentation" tit
         })()
       </script>
 
-    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
-    <script src="../_static/doctools.js"></script>
-    <script src="../_static/sphinx_highlight.js"></script>
-    <script src="../_static/scripts/furo.js"></script>
+    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=dda0c7a7"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="../_static/scripts/furo.js?v=7660844c"></script>
 
     <script>
 
@@ -559,7 +570,7 @@ <h1>ViZDoom documentation<a class="headerlink" href="#vizdoom-documentation" tit
             const subSectionContainerElem = Object.assign(
                 document.createElement('div'), {
                   className:'farama-header-menu__subsections-container',
-                  style: key == "Mature Projects" ? "display: flex" : ""
+                  style: 'display: flex'
                 }
             )
             Object.keys(subSections).forEach((subKey, i) => {
@@ -574,7 +585,7 @@ <h1>ViZDoom documentation<a class="headerlink" href="#vizdoom-documentation" tit
                   innerText: subKey
                 }
               ))
-              const ulElem = createProjectsList(subSections[subKey], key !== "Foundation");
+              const ulElem = createProjectsList(subSections[subKey], key !== 'Foundation');
               subSectionElem.appendChild(ulElem);
               subSectionContainerElem.appendChild(subSectionElem);
             })

_static/basic.css

@@ -670,6 +670,16 @@ dd {
     margin-left: 30px;
 }
 
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
     margin-bottom: 0;
@@ -738,6 +748,14 @@ abbr, acronym {
     cursor: help;
 }
 
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {

_static/pygments.css

@@ -22,6 +22,7 @@
 .highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */
 .highlight .gd { color: #a40000 } /* Generic.Deleted */
 .highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */
+.highlight .ges { color: #000000; font-weight: bold; font-style: italic } /* Generic.EmphStrong */
 .highlight .gr { color: #ef2929 } /* Generic.Error */
 .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
 .highlight .gi { color: #00A000 } /* Generic.Inserted */
@@ -107,6 +108,7 @@ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /*
 body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */
 body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */
 body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */
+body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */
 body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */
 body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */
 body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */
@@ -192,6 +194,7 @@ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: ital
 body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */
 body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */
 body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */
+body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */
 body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */
 body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */
 body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */