Unified the docs filenames with outher Farama projects

Farama-Foundation · Feb 12, 2024 · 563a2a4 · 563a2a4
1 parent c281265
commit 563a2a4
Show file tree

Hide file tree

Showing 12 changed files with 8 additions and 8 deletions.
diff --git a/docs/api/configurationFiles.md → docs/api/configuration_files.md b/docs/api/configurationFiles.md → docs/api/configuration_files.md
diff --git a/docs/api/cpp/doomGame.md → docs/api/cpp/doom_game.md b/docs/api/cpp/doomGame.md → docs/api/cpp/doom_game.md
diff --git a/docs/api/cpp/gameState.md → docs/api/cpp/game_state.md b/docs/api/cpp/gameState.md → docs/api/cpp/game_state.md
diff --git a/docs/api/python/doomGame.md → docs/api/python/doom_game.md b/docs/api/python/doomGame.md → docs/api/python/doom_game.md
diff --git a/docs/api/python/gameState.md → docs/api/python/game_state.md b/docs/api/python/gameState.md → docs/api/python/game_state.md
diff --git a/docs/environments/creatingCustom.md → docs/environments/creating_custom.md b/docs/environments/creatingCustom.md → docs/environments/creating_custom.md
diff --git a/docs/environments/thirdParty.md → docs/environments/third_party.md b/docs/environments/thirdParty.md → docs/environments/third_party.md
diff --git 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,16 +70,16 @@ introduction/apisAndWrappers
 
 api/python
 api/cpp
-api/configurationFiles
+api/configuration_files
 ```
 
 ```{toctree}
 :hidden:
 :caption: Environments
 
 environments/default
-environments/thirdParty
-environments/creatingCustom
+environments/third_party
+environments/creating_custom
 ```
 
 ```{toctree}

diff --git a/docs/introduction/apisAndWrappers.md → docs/introduction/apis_and_wrappers.md b/docs/introduction/apisAndWrappers.md → docs/introduction/apis_and_wrappers.md
diff --git a/docs/introduction/pythonQuickstart.md → docs/introduction/python_quickstart.md b/docs/introduction/pythonQuickstart.md → 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
@@ -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
@@ -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"