From 563a2a46cff9651440eb827cd376beb7c89a4970 Mon Sep 17 00:00:00 2001
From: Marek Wydmuch <marek@wydmuch.poznan.pl>
Date: Mon, 12 Feb 2024 02:17:37 +0100
Subject: [PATCH] Unified the docs filenames with outher Farama projects

---
 .../{configurationFiles.md => configuration_files.md}  |  0
 docs/api/cpp/{doomGame.md => doom_game.md}             |  0
 docs/api/cpp/{gameState.md => game_state.md}           |  0
 docs/api/python/{doomGame.md => doom_game.md}          |  0
 docs/api/python/{gameState.md => game_state.md}        |  0
 .../{creatingCustom.md => creating_custom.md}          |  0
 docs/environments/{thirdParty.md => third_party.md}    |  0
 docs/index.md                                          | 10 +++++-----
 .../{apisAndWrappers.md => apis_and_wrappers.md}       |  0
 .../{pythonQuickstart.md => python_quickstart.md}      |  0
 scripts/create_python_docs_from_cpp_docs.py            |  4 ++--
 scripts/create_python_docstrings_from_cpp_docs.py      |  2 +-
 12 files changed, 8 insertions(+), 8 deletions(-)
 rename docs/api/{configurationFiles.md => configuration_files.md} (100%)
 rename docs/api/cpp/{doomGame.md => doom_game.md} (100%)
 rename docs/api/cpp/{gameState.md => game_state.md} (100%)
 rename docs/api/python/{doomGame.md => doom_game.md} (100%)
 rename docs/api/python/{gameState.md => game_state.md} (100%)
 rename docs/environments/{creatingCustom.md => creating_custom.md} (100%)
 rename docs/environments/{thirdParty.md => third_party.md} (100%)
 rename docs/introduction/{apisAndWrappers.md => apis_and_wrappers.md} (100%)
 rename docs/introduction/{pythonQuickstart.md => python_quickstart.md} (100%)

diff --git a/docs/api/configurationFiles.md b/docs/api/configuration_files.md
similarity index 100%
rename from docs/api/configurationFiles.md
rename to docs/api/configuration_files.md
diff --git a/docs/api/cpp/doomGame.md b/docs/api/cpp/doom_game.md
similarity index 100%
rename from docs/api/cpp/doomGame.md
rename to docs/api/cpp/doom_game.md
diff --git a/docs/api/cpp/gameState.md b/docs/api/cpp/game_state.md
similarity index 100%
rename from docs/api/cpp/gameState.md
rename to docs/api/cpp/game_state.md
diff --git a/docs/api/python/doomGame.md b/docs/api/python/doom_game.md
similarity index 100%
rename from docs/api/python/doomGame.md
rename to docs/api/python/doom_game.md
diff --git a/docs/api/python/gameState.md b/docs/api/python/game_state.md
similarity index 100%
rename from docs/api/python/gameState.md
rename to docs/api/python/game_state.md
diff --git a/docs/environments/creatingCustom.md b/docs/environments/creating_custom.md
similarity index 100%
rename from docs/environments/creatingCustom.md
rename to docs/environments/creating_custom.md
diff --git a/docs/environments/thirdParty.md b/docs/environments/third_party.md
similarity index 100%
rename from docs/environments/thirdParty.md
rename to docs/environments/third_party.md
diff --git a/docs/index.md b/docs/index.md
index baf907f24..fb48c44bc 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -59,9 +59,9 @@ game.close()
 :hidden:
 :caption: Introduction
 
-introduction/pythonQuickstart
+introduction/python_quickstart
 introduction/building
-introduction/apisAndWrappers
+introduction/apis_and_wrappers
 ```
 
 ```{toctree}
@@ -70,7 +70,7 @@ introduction/apisAndWrappers
 
 api/python
 api/cpp
-api/configurationFiles
+api/configuration_files
 ```
 
 ```{toctree}
@@ -78,8 +78,8 @@ api/configurationFiles
 :caption: Environments
 
 environments/default
-environments/thirdParty
-environments/creatingCustom
+environments/third_party
+environments/creating_custom
 ```
 
 ```{toctree}
diff --git a/docs/introduction/apisAndWrappers.md b/docs/introduction/apis_and_wrappers.md
similarity index 100%
rename from docs/introduction/apisAndWrappers.md
rename to docs/introduction/apis_and_wrappers.md
diff --git a/docs/introduction/pythonQuickstart.md b/docs/introduction/python_quickstart.md
similarity index 100%
rename from docs/introduction/pythonQuickstart.md
rename to docs/introduction/python_quickstart.md
diff --git a/scripts/create_python_docs_from_cpp_docs.py b/scripts/create_python_docs_from_cpp_docs.py
index c86a4542e..b1c11b206 100755
--- a/scripts/create_python_docs_from_cpp_docs.py
+++ b/scripts/create_python_docs_from_cpp_docs.py
@@ -5,8 +5,8 @@
 
 FILES_TO_PARSE = [
     {
-        "input_filepath": "docs/api/cpp/doomGame.md",
-        "output_filepath": "docs/api/python/doomGame.md",
+        "input_filepath": "docs/api/cpp/doom_game.md",
+        "output_filepath": "docs/api/python/doom_game.md",
         "submodule": "DoomGame.",
         "append_to_header": """
 ```{eval-rst}
diff --git a/scripts/create_python_docstrings_from_cpp_docs.py b/scripts/create_python_docstrings_from_cpp_docs.py
index bcbf20afd..0c91df821 100755
--- a/scripts/create_python_docstrings_from_cpp_docs.py
+++ b/scripts/create_python_docstrings_from_cpp_docs.py
@@ -9,7 +9,7 @@ def camel_case_to_snake_case(text):
 
 
 FILES_TO_PARSE = [
-    {"filepath": "docs/api/cpp/doomGame.md", "namespace": "DoomGamePython"},
+    {"filepath": "docs/api/cpp/doom_game.md", "namespace": "DoomGamePython"},
     {"filepath": "docs/api/cpp/utils.md"},
 ]
 OUTPUT_FILE = "src/lib_python/ViZDoomMethodsDocstrings.h"