Schola v1.1.0

Author: kurbeco

.gitignore

@@ -116,7 +116,7 @@ documentation/*.bkp
 !/Docs/Sphinx/API/python_generated.rst
 !/Docs/Sphinx/API/python_core.rst
 !/Docs/Sphinx/API/python_extensions.rst
-!/Docs/Sphinx/API/python_scripting.rst
+!/Docs/Sphinx/API/python_scripts.rst
 
 
 

CITATION.cff

@@ -0,0 +1,39 @@
+cff-version: 1.2.0
+title: Schola
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - given-names: Alexander
+    family-names: Cann
+    name-particle: Alexander
+    email: [email protected]
+    affiliation: AMD
+  - given-names: Tian Yue
+    family-names: Liu
+    email: [email protected]
+    affiliation: AMD
+  - given-names: Nathan
+    family-names: Hung
+    email: [email protected]
+    affiliation: AMD
+  - given-names: Mehdi
+    family-names: Saeedi
+    email: [email protected]
+    affiliation: AMD
+repository-code: 'https://github.com/GPUOpen-LibrariesAndSDKs/Schola'
+url: 'https://gpuopen.com/amd-schola/'
+abstract: >-
+  Schola is a plugin for enabling Reinforcement Learning
+  (RL) in Unreal Engine. It provides tools to help
+  developers create environments, define agents, and connect
+  to python-based RL frameworks such as OpenAI Gym, RLlib or
+  Stable Baselines 3 for training agents with RL.
+keywords:
+  - Reinforcement Learning
+  - Unreal  Engine 5
+  - Python
+license: MIT
+version: '1.1'
+date-released: '2025-04-01'

Config/DefaultSchola.ini

@@ -0,0 +1,2 @@
+[CoreRedirects]
++ClassRedirects=(OldName="/Script/Schola.BlueprintScholaEnvironment",NewName="/Script/Schola.BlueprintStaticScholaEnvironment")

Docs/Doxygen/Doxyfile

@@ -943,7 +943,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = C:/Users/alexcann/source/repos/UERL/Plugins/Schola/Source/Schola
+INPUT                  = ./../../Source/Schola
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

Docs/Sphinx/API/api_toc.rst

@@ -0,0 +1,55 @@
+API Documentation
+=================
+
+
+Python
+~~~~~~
+
+Core
+^^^^
+
+.. autosummary::
+   :toctree: Python
+   :recursive:
+
+   schola.core
+
+Extensions
+^^^^^^^^^^
+
+.. autosummary::
+   :toctree: Python
+   :recursive:
+
+   schola.sb3
+   schola.ray
+   schola.gym
+
+Scripts
+^^^^^^^
+
+.. autosummary::
+   :toctree: Python
+   :recursive:
+
+   schola.scripts
+
+Generated gRPC Code
+^^^^^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: Python
+   :recursive:
+
+   schola.generated
+
+Unreal
+~~~~~~
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Unreal API Documentation
+
+   Unreal/classlist
+   Unreal/structlist
+   Unreal/namespacelist

Docs/Sphinx/API/python_core.rst

@@ -12,7 +12,14 @@ BUILDDIR      = _build
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-.PHONY: help Makefile
+.PHONY: help Makefile all
+
+all:
+	doxygen ../Doxygen/Doxyfile
+	breathe-apidoc -o API/Unreal ../Doxygen/xml
+	rm -r ./API/Unreal/file
+	rm ./API/Unreal/filelist.rst
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).