[SymForce] Fix links from generated to symbolic classes

Topic: sym-docs-gen-links GitOrigin-RevId: bfddc6e09b33a2c145ce8c8b83545e7dbe01f1f4
symforce-org · May 31, 2023 · cce64be · cce64be
1 parent c3d2f3c
commit cce64be
Show file tree

Hide file tree

Showing 26 changed files with 28 additions and 30 deletions.
diff --git a/gen/cpp/sym/atan_camera_cal.h b/gen/cpp/sym/atan_camera_cal.h
diff --git a/gen/cpp/sym/double_sphere_camera_cal.h b/gen/cpp/sym/double_sphere_camera_cal.h
diff --git a/gen/cpp/sym/equirectangular_camera_cal.h b/gen/cpp/sym/equirectangular_camera_cal.h
diff --git a/gen/cpp/sym/linear_camera_cal.h b/gen/cpp/sym/linear_camera_cal.h
diff --git a/gen/cpp/sym/polynomial_camera_cal.h b/gen/cpp/sym/polynomial_camera_cal.h
diff --git a/gen/cpp/sym/pose2.h b/gen/cpp/sym/pose2.h
diff --git a/gen/cpp/sym/pose3.h b/gen/cpp/sym/pose3.h
diff --git a/gen/cpp/sym/rot2.h b/gen/cpp/sym/rot2.h
diff --git a/gen/cpp/sym/rot3.h b/gen/cpp/sym/rot3.h
diff --git a/gen/cpp/sym/spherical_camera_cal.h b/gen/cpp/sym/spherical_camera_cal.h
diff --git a/gen/cpp/sym/unit3.h b/gen/cpp/sym/unit3.h
diff --git a/gen/python/sym/atan_camera_cal.py b/gen/python/sym/atan_camera_cal.py
diff --git a/gen/python/sym/double_sphere_camera_cal.py b/gen/python/sym/double_sphere_camera_cal.py
diff --git a/gen/python/sym/equirectangular_camera_cal.py b/gen/python/sym/equirectangular_camera_cal.py
diff --git a/gen/python/sym/linear_camera_cal.py b/gen/python/sym/linear_camera_cal.py
diff --git a/gen/python/sym/polynomial_camera_cal.py b/gen/python/sym/polynomial_camera_cal.py
diff --git a/gen/python/sym/pose2.py b/gen/python/sym/pose2.py
diff --git a/gen/python/sym/pose3.py b/gen/python/sym/pose3.py
diff --git a/gen/python/sym/rot2.py b/gen/python/sym/rot2.py
diff --git a/gen/python/sym/rot3.py b/gen/python/sym/rot3.py
diff --git a/gen/python/sym/spherical_camera_cal.py b/gen/python/sym/spherical_camera_cal.py
diff --git a/gen/python/sym/unit3.py b/gen/python/sym/unit3.py
diff --git a/symforce/codegen/backends/cpp/templates/cam_package/CLASS.h.jinja b/symforce/codegen/backends/cpp/templates/cam_package/CLASS.h.jinja
@@ -18,7 +18,7 @@ namespace sym {
 
 {% if doc %}
 /**
- * Autogenerated C++ implementation of {{ cls }}.
+ * Autogenerated C++ implementation of `{{ cls.__module__ }}.{{ cls.__qualname__ }}`.
  *
 {% for line in doc.split('\n') %}
  *{{ ' {}'.format(line).rstrip() }}

diff --git a/symforce/codegen/backends/cpp/templates/geo_package/CLASS.h.jinja b/symforce/codegen/backends/cpp/templates/geo_package/CLASS.h.jinja
@@ -28,7 +28,7 @@ namespace sym {
 
 {% if doc %}
 /**
- * Autogenerated C++ implementation of {{ cls }}.
+ * Autogenerated C++ implementation of `{{ cls.__module__ }}.{{ cls.__qualname__ }}`.
  *
 {% for line in doc.split('\n') %}
  *{{ ' {}'.format(line).rstrip() }}

diff --git a/symforce/codegen/backends/python/templates/cam_package/CLASS.py.jinja b/symforce/codegen/backends/python/templates/cam_package/CLASS.py.jinja
@@ -13,7 +13,7 @@ from .ops import {{ camelcase_to_snakecase(cls.__name__) }} as ops
 class {{ cls.__name__ }}(object):
     {% if doc %}
     """
-    Autogenerated Python implementation of {{ cls }}.
+    Autogenerated Python implementation of :py:class:`{{ cls.__module__ }}.{{ cls.__qualname__ }}`.
 
     {% for line in doc.split('\n') %}
     {{ line.rstrip() }}

diff --git a/symforce/codegen/backends/python/templates/geo_package/CLASS.py.jinja b/symforce/codegen/backends/python/templates/geo_package/CLASS.py.jinja
@@ -21,7 +21,7 @@ from .ops import {{ camelcase_to_snakecase(cls.__name__) }} as ops
 class {{ cls.__name__ }}(object):
     {% if doc %}
     """
-    Autogenerated Python implementation of {{ cls }}.
+    Autogenerated Python implementation of :py:class:`{{ cls.__module__ }}.{{ cls.__qualname__ }}`.
 
     {% for line in doc.split('\n') %}
     {{ line.rstrip() }}