Removing sfx error message and updating doc

docs/Makefile

@@ -20,6 +20,6 @@ help:
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 rst: Makefile
-	@$(SPHINXBUILD) -M rst "$(SOURCEDIR)/auto" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M rst "$(SOURCEDIR)/auto" "$(BUILDDIR)" $(SPHINXOPTS) -E $(O)
 	cp -f "$(BUILDDIR)"/rst/*.grst auto/
 

docs/auto/conf.py

@@ -48,6 +48,7 @@
     'rst',
 ]
 
+autodoc_docstring_signature = True
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

docs/auto/graphicsconfig.grst

@@ -16,6 +16,12 @@
       Low-definition graphics settings
 
 
+   .. py:method:: none () -> pystk.GraphicsConfig
+      :staticmethod:
+
+      Disable graphics and rendering
+
+
    .. py:method:: sd () -> pystk.GraphicsConfig
       :staticmethod:
 
@@ -40,6 +46,12 @@
       Disable specular IBL
 
 
+   .. py:method:: display_adapter () -> int
+      :property:
+
+      GPU to use (Linux only)
+
+
    .. py:method:: dof () -> bool
       :property:
 
@@ -88,6 +100,12 @@
       Particle effect 0 (none) to 2 (full)
 
 
+   .. py:method:: render () -> bool
+      :property:
+
+      Is rendering enabled?
+
+
    .. py:method:: screen_height () -> int
       :property:
 

docs/auto/log.grst

@@ -19,8 +19,8 @@
    .. py:method:: name () -> str
       :property:
 
-      (self: handle) -> str
-
+   .. py:method:: value () -> int
+      :property:
 
    .. py:attribute:: verbose
       :annotation: = 1

docs/auto/objecttype.grst

@@ -21,9 +21,6 @@
    .. py:method:: name () -> str
       :property:
 
-      (self: handle) -> str
-
-
    .. py:attribute:: nitro
       :annotation: = 5
 
@@ -41,3 +38,6 @@
 
    .. py:attribute:: unknown
       :annotation: = 9
+
+   .. py:method:: value () -> int
+      :property:

docs/auto/playerconfig.grst

@@ -15,8 +15,8 @@
       .. py:method:: name () -> str
          :property:
 
-         (self: handle) -> str
-
+      .. py:method:: value () -> int
+         :property:
 
    .. py:method:: controller () -> pystk.PlayerConfig.Controller
       :property:

docs/auto/race.grst

@@ -50,12 +50,6 @@
       The current race configuration
 
 
-   .. py:method:: last_action () -> List[pystk.Action]
-      :property:
-
-      the last action the agent took
-
-
    .. py:method:: render_data () -> List[pystk.RenderData]
       :property:
 

docs/auto/raceconfig.grst

@@ -30,8 +30,8 @@
       .. py:method:: name () -> str
          :property:
 
-         (self: handle) -> str
-
+      .. py:method:: value () -> int
+         :property:
 
    .. py:method:: difficulty () -> int
       :property:
@@ -63,12 +63,6 @@
       List of all agent players
 
 
-   .. py:method:: render () -> bool
-      :property:
-
-      Is rendering enabled?
-
-
    .. py:method:: reverse () -> bool
       :property:
 

docs/auto/renderdata.grst

@@ -4,19 +4,19 @@
    SuperTuxKart rendering output
 
 
-   .. py:method:: depth () -> array
+   .. py:method:: depth () -> numpy.ndarray
       :property:
 
       Depth image of the kart (memoryview[float] screen_height x screen_width)
 
 
-   .. py:method:: image () -> array
+   .. py:method:: image () -> numpy.ndarray
       :property:
 
       Color image of the kart (memoryview[uint8] screen_height x screen_width x 3)
 
 
-   .. py:method:: instance () -> array
+   .. py:method:: instance () -> numpy.ndarray
       :property:
 
       Instance labels (memoryview[uint32] screen_height x screen_width)

docs/auto/rst/builder.py

@@ -16,7 +16,8 @@
 
 
 def get_text(e):
-    return ''.join(str(c) for c in e.children)
+    import docutils
+    return ''.join(str(c) if isinstance(c, docutils.nodes.Text) else get_text(c) for c in e.children)
 
 
 def gen_signature(s, indent):
@@ -117,6 +118,9 @@ def init(self):
     def prepare_writing(self, docnames):
         pass
 
+    def get_target_uri(self, docname: str, typ: str = None):
+        return docname
+
     def write_doc(self, docname, doctree):
         outfilename = path.join(self.outdir, docname+self.file_suffix)
         # print "write(%s,%s) -> %s" % (type(doctree), type(destination), outfilename)

docs/auto/rst/property.py

@@ -1,6 +1,4 @@
 from sphinx.ext.autodoc import PropertyDocumenter, AttributeDocumenter, ClassLevelDocumenter, SUPPRESS
-from sphinx.util import inspect
-from typing import Any, Callable, Dict, Iterator, List, Sequence, Set, Tuple, Union
 
 
 class TypedPropertyDocumenter(PropertyDocumenter):  # type: ignore
@@ -14,9 +12,6 @@ class TypedPropertyDocumenter(PropertyDocumenter):  # type: ignore
     # before AttributeDocumenter
     priority = PropertyDocumenter.priority + 10
 
-    def document_members(self, all_members: bool = False) -> None:
-        pass
-
     def format_signature(self, **kwargs) -> str:
         from inspect import signature, getdoc
         sig = super().format_signature(**kwargs)
@@ -27,6 +22,8 @@ def format_signature(self, **kwargs) -> str:
 
     def add_directive_header(self, sig: str) -> None:
         super().add_directive_header(sig)
+        sourcename = self.get_sourcename()
+        self.add_line('   :property:', sourcename)
 
 
 class EnumAttributeDocumenter(AttributeDocumenter):  # type: ignore
@@ -40,13 +37,12 @@ def add_directive_header(self, sig: str) -> None:
         ClassLevelDocumenter.add_directive_header(self, sig)
         sourcename = self.get_sourcename()
         if not self.options.annotation:
-            if not self._datadescriptor:
-                try:
-                    objrepr = str(int(self.object))
-                except ValueError:
-                    pass
-                else:
-                    self.add_line('   :annotation: = ' + objrepr, sourcename)
+            try:
+                objrepr = str(int(self.object))
+            except ValueError:
+                pass
+            else:
+                self.add_line('   :annotation: = ' + objrepr, sourcename)
         elif self.options.annotation is SUPPRESS:
             pass
         else:

docs/auto/state.grst

@@ -64,19 +64,19 @@
       length of the track
 
 
-   .. py:method:: path_distance () -> numpy.ndarray[float32]
+   .. py:method:: path_distance () -> numpy.ndarray[numpy.float32]
       :property:
 
       Distance down the track of each line segment (float N x 2)
 
 
-   .. py:method:: path_nodes () -> numpy.ndarray[float32]
+   .. py:method:: path_nodes () -> numpy.ndarray[numpy.float32]
       :property:
 
       Center line of the drivable area as line segments of 3d coordinates (float N x 2 x 3)
 
 
-   .. py:method:: path_width () -> numpy.ndarray[float32]
+   .. py:method:: path_width () -> numpy.ndarray[numpy.float32]
       :property:
 
       Width of the path segment (float N)
@@ -118,8 +118,8 @@
       .. py:method:: name () -> str
          :property:
 
-         (self: handle) -> str
-
+      .. py:method:: value () -> int
+         :property:
 
    .. py:method:: aspect () -> float
       :property:
@@ -176,8 +176,8 @@
       .. py:method:: name () -> str
          :property:
 
-         (self: handle) -> str
-
+      .. py:method:: value () -> int
+         :property:
 
    .. py:method:: id () -> int
       :property:
@@ -371,8 +371,8 @@
       .. py:method:: name () -> str
          :property:
 
-         (self: handle) -> str
-
+      .. py:method:: value () -> int
+         :property:
 
    .. py:method:: num () -> int
       :property:
@@ -411,8 +411,8 @@
       .. py:method:: name () -> str
          :property:
 
-         (self: handle) -> str
-
+      .. py:method:: value () -> int
+         :property:
 
    .. py:method:: time_left () -> float
       :property:

setup.py

@@ -122,7 +122,7 @@ def ignore(base, entries):
 
 setup(
     name='PySuperTuxKart',
-    version='1.1.1',
+    version='1.1.2',
     author='Philipp Krähenbühl',
     author_email='philkr@utexas.edu',
     description='Python SuperTuxKart inferface',

src/tracks/track_object.cpp

@@ -172,6 +172,7 @@ void TrackObject::init(const XMLNode &xml_node, scene::ISceneNode* parent,
             Track::getCurrentTrack()->addMetaLibrary(parent_library, this);
         }
     }
+    else if (type == "sfx-emitter") {}
     else if (type == "action-trigger")
     {
         std::string action;