From cce64be34b0f38e6fa2d497dd0d84ca838b0d24d Mon Sep 17 00:00:00 2001 From: Aaron Date: Fri, 12 May 2023 02:27:07 +0000 Subject: [PATCH] [SymForce] Fix links from generated to symbolic classes Topic: sym-docs-gen-links GitOrigin-RevId: bfddc6e09b33a2c145ce8c8b83545e7dbe01f1f4 --- gen/cpp/sym/atan_camera_cal.h | 2 +- gen/cpp/sym/double_sphere_camera_cal.h | 4 ++-- gen/cpp/sym/equirectangular_camera_cal.h | 4 ++-- gen/cpp/sym/linear_camera_cal.h | 2 +- gen/cpp/sym/polynomial_camera_cal.h | 3 +-- gen/cpp/sym/pose2.h | 2 +- gen/cpp/sym/pose3.h | 2 +- gen/cpp/sym/rot2.h | 2 +- gen/cpp/sym/rot3.h | 2 +- gen/cpp/sym/spherical_camera_cal.h | 3 +-- gen/cpp/sym/unit3.h | 2 +- gen/python/sym/atan_camera_cal.py | 2 +- gen/python/sym/double_sphere_camera_cal.py | 2 +- gen/python/sym/equirectangular_camera_cal.py | 2 +- gen/python/sym/linear_camera_cal.py | 2 +- gen/python/sym/polynomial_camera_cal.py | 2 +- gen/python/sym/pose2.py | 2 +- gen/python/sym/pose3.py | 2 +- gen/python/sym/rot2.py | 2 +- gen/python/sym/rot3.py | 2 +- gen/python/sym/spherical_camera_cal.py | 2 +- gen/python/sym/unit3.py | 2 +- .../codegen/backends/cpp/templates/cam_package/CLASS.h.jinja | 2 +- .../codegen/backends/cpp/templates/geo_package/CLASS.h.jinja | 2 +- .../backends/python/templates/cam_package/CLASS.py.jinja | 2 +- .../backends/python/templates/geo_package/CLASS.py.jinja | 2 +- 26 files changed, 28 insertions(+), 30 deletions(-) diff --git a/gen/cpp/sym/atan_camera_cal.h b/gen/cpp/sym/atan_camera_cal.h index 28ce4146b..7c56eefe6 100644 --- a/gen/cpp/sym/atan_camera_cal.h +++ b/gen/cpp/sym/atan_camera_cal.h @@ -17,7 +17,7 @@ namespace sym { /** - * Autogenerated C++ implementation of . + * Autogenerated C++ implementation of `symforce.cam.atan_camera_cal.ATANCameraCal`. * * ATAN camera with 5 parameters [fx, fy, cx, cy, omega]. * (fx, fy) representing focal length, (cx, cy) representing principal point, diff --git a/gen/cpp/sym/double_sphere_camera_cal.h b/gen/cpp/sym/double_sphere_camera_cal.h index e2684e77d..930dd352b 100644 --- a/gen/cpp/sym/double_sphere_camera_cal.h +++ b/gen/cpp/sym/double_sphere_camera_cal.h @@ -17,8 +17,8 @@ namespace sym { /** - * Autogenerated C++ implementation of . + * Autogenerated C++ implementation of + * `symforce.cam.double_sphere_camera_cal.DoubleSphereCameraCal`. * * Camera model where a point is consecutively projected onto two unit spheres * with centers shifted by ``xi``, then projected into the image plane using the diff --git a/gen/cpp/sym/equirectangular_camera_cal.h b/gen/cpp/sym/equirectangular_camera_cal.h index 7684a3331..3b65bb3af 100644 --- a/gen/cpp/sym/equirectangular_camera_cal.h +++ b/gen/cpp/sym/equirectangular_camera_cal.h @@ -17,8 +17,8 @@ namespace sym { /** - * Autogenerated C++ implementation of . + * Autogenerated C++ implementation of + * `symforce.cam.equirectangular_camera_cal.EquirectangularCameraCal`. * * Equirectangular camera model with parameters [fx, fy, cx, cy]. * diff --git a/gen/cpp/sym/linear_camera_cal.h b/gen/cpp/sym/linear_camera_cal.h index af5dcb32b..e57a504e7 100644 --- a/gen/cpp/sym/linear_camera_cal.h +++ b/gen/cpp/sym/linear_camera_cal.h @@ -17,7 +17,7 @@ namespace sym { /** - * Autogenerated C++ implementation of . + * Autogenerated C++ implementation of `symforce.cam.linear_camera_cal.LinearCameraCal`. * * Standard pinhole camera w/ four parameters [fx, fy, cx, cy]. * diff --git a/gen/cpp/sym/polynomial_camera_cal.h b/gen/cpp/sym/polynomial_camera_cal.h index 96f998b12..e07cd517d 100644 --- a/gen/cpp/sym/polynomial_camera_cal.h +++ b/gen/cpp/sym/polynomial_camera_cal.h @@ -17,8 +17,7 @@ namespace sym { /** - * Autogenerated C++ implementation of . + * Autogenerated C++ implementation of `symforce.cam.polynomial_camera_cal.PolynomialCameraCal`. * * Polynomial camera model in the style of OpenCV * diff --git a/gen/cpp/sym/pose2.h b/gen/cpp/sym/pose2.h index a4926a1a5..c2c9391ba 100644 --- a/gen/cpp/sym/pose2.h +++ b/gen/cpp/sym/pose2.h @@ -21,7 +21,7 @@ namespace sym { /** - * Autogenerated C++ implementation of . + * Autogenerated C++ implementation of `symforce.geo.pose2.Pose2`. * * Group of two-dimensional rigid body transformations - R2 x SO(2). * diff --git a/gen/cpp/sym/pose3.h b/gen/cpp/sym/pose3.h index 11362794f..17bc4925a 100644 --- a/gen/cpp/sym/pose3.h +++ b/gen/cpp/sym/pose3.h @@ -21,7 +21,7 @@ namespace sym { /** - * Autogenerated C++ implementation of . + * Autogenerated C++ implementation of `symforce.geo.pose3.Pose3`. * * Group of three-dimensional rigid body transformations - SO(3) x R3. * diff --git a/gen/cpp/sym/rot2.h b/gen/cpp/sym/rot2.h index b9581f47e..aaaab3f6b 100644 --- a/gen/cpp/sym/rot2.h +++ b/gen/cpp/sym/rot2.h @@ -20,7 +20,7 @@ namespace sym { /** - * Autogenerated C++ implementation of . + * Autogenerated C++ implementation of `symforce.geo.rot2.Rot2`. * * Group of two-dimensional orthogonal matrices with determinant +1, representing rotations * in 2D space. Backed by a complex number. diff --git a/gen/cpp/sym/rot3.h b/gen/cpp/sym/rot3.h index fa801b3aa..261550444 100644 --- a/gen/cpp/sym/rot3.h +++ b/gen/cpp/sym/rot3.h @@ -20,7 +20,7 @@ namespace sym { /** - * Autogenerated C++ implementation of . + * Autogenerated C++ implementation of `symforce.geo.rot3.Rot3`. * * Group of three-dimensional orthogonal matrices with determinant +1, representing * rotations in 3D space. Backed by a quaternion with (x, y, z, w) storage. diff --git a/gen/cpp/sym/spherical_camera_cal.h b/gen/cpp/sym/spherical_camera_cal.h index 2716d26d8..ea7a9fd80 100644 --- a/gen/cpp/sym/spherical_camera_cal.h +++ b/gen/cpp/sym/spherical_camera_cal.h @@ -17,8 +17,7 @@ namespace sym { /** - * Autogenerated C++ implementation of . + * Autogenerated C++ implementation of `symforce.cam.spherical_camera_cal.SphericalCameraCal`. * * Kannala-Brandt camera model, where radial distortion is modeled relative to the 3D angle theta * off the optical axis as opposed to radius within the image plane (i.e. ATANCamera) diff --git a/gen/cpp/sym/unit3.h b/gen/cpp/sym/unit3.h index 00f38c42b..6fde21528 100644 --- a/gen/cpp/sym/unit3.h +++ b/gen/cpp/sym/unit3.h @@ -21,7 +21,7 @@ namespace sym { /** - * Autogenerated C++ implementation of . + * Autogenerated C++ implementation of `symforce.geo.unit3.Unit3`. * * Direction in R^3, represented as a :class:`Rot3 ` that transforms * [0, 0, 1] to the desired direction. diff --git a/gen/python/sym/atan_camera_cal.py b/gen/python/sym/atan_camera_cal.py index 5317558fe..72768e7f3 100644 --- a/gen/python/sym/atan_camera_cal.py +++ b/gen/python/sym/atan_camera_cal.py @@ -13,7 +13,7 @@ class ATANCameraCal(object): """ - Autogenerated Python implementation of . + Autogenerated Python implementation of :py:class:`symforce.cam.atan_camera_cal.ATANCameraCal`. ATAN camera with 5 parameters [fx, fy, cx, cy, omega]. (fx, fy) representing focal length, (cx, cy) representing principal point, diff --git a/gen/python/sym/double_sphere_camera_cal.py b/gen/python/sym/double_sphere_camera_cal.py index 3855d689b..ff9155a4c 100644 --- a/gen/python/sym/double_sphere_camera_cal.py +++ b/gen/python/sym/double_sphere_camera_cal.py @@ -13,7 +13,7 @@ class DoubleSphereCameraCal(object): """ - Autogenerated Python implementation of . + Autogenerated Python implementation of :py:class:`symforce.cam.double_sphere_camera_cal.DoubleSphereCameraCal`. Camera model where a point is consecutively projected onto two unit spheres with centers shifted by ``xi``, then projected into the image plane using the diff --git a/gen/python/sym/equirectangular_camera_cal.py b/gen/python/sym/equirectangular_camera_cal.py index e4210f5ef..111bb8d67 100644 --- a/gen/python/sym/equirectangular_camera_cal.py +++ b/gen/python/sym/equirectangular_camera_cal.py @@ -13,7 +13,7 @@ class EquirectangularCameraCal(object): """ - Autogenerated Python implementation of . + Autogenerated Python implementation of :py:class:`symforce.cam.equirectangular_camera_cal.EquirectangularCameraCal`. Equirectangular camera model with parameters [fx, fy, cx, cy]. diff --git a/gen/python/sym/linear_camera_cal.py b/gen/python/sym/linear_camera_cal.py index 869728473..fa838e75b 100644 --- a/gen/python/sym/linear_camera_cal.py +++ b/gen/python/sym/linear_camera_cal.py @@ -13,7 +13,7 @@ class LinearCameraCal(object): """ - Autogenerated Python implementation of . + Autogenerated Python implementation of :py:class:`symforce.cam.linear_camera_cal.LinearCameraCal`. Standard pinhole camera w/ four parameters [fx, fy, cx, cy]. diff --git a/gen/python/sym/polynomial_camera_cal.py b/gen/python/sym/polynomial_camera_cal.py index 4b296c34d..eae3e81d0 100644 --- a/gen/python/sym/polynomial_camera_cal.py +++ b/gen/python/sym/polynomial_camera_cal.py @@ -13,7 +13,7 @@ class PolynomialCameraCal(object): """ - Autogenerated Python implementation of . + Autogenerated Python implementation of :py:class:`symforce.cam.polynomial_camera_cal.PolynomialCameraCal`. Polynomial camera model in the style of OpenCV diff --git a/gen/python/sym/pose2.py b/gen/python/sym/pose2.py index 8ceccdbb2..ef46543e0 100644 --- a/gen/python/sym/pose2.py +++ b/gen/python/sym/pose2.py @@ -17,7 +17,7 @@ class Pose2(object): """ - Autogenerated Python implementation of . + Autogenerated Python implementation of :py:class:`symforce.geo.pose2.Pose2`. Group of two-dimensional rigid body transformations - R2 x SO(2). diff --git a/gen/python/sym/pose3.py b/gen/python/sym/pose3.py index fc9620437..3bf14469a 100644 --- a/gen/python/sym/pose3.py +++ b/gen/python/sym/pose3.py @@ -17,7 +17,7 @@ class Pose3(object): """ - Autogenerated Python implementation of . + Autogenerated Python implementation of :py:class:`symforce.geo.pose3.Pose3`. Group of three-dimensional rigid body transformations - SO(3) x R3. diff --git a/gen/python/sym/rot2.py b/gen/python/sym/rot2.py index 4c35a3a0a..d2d7254f0 100644 --- a/gen/python/sym/rot2.py +++ b/gen/python/sym/rot2.py @@ -15,7 +15,7 @@ class Rot2(object): """ - Autogenerated Python implementation of . + Autogenerated Python implementation of :py:class:`symforce.geo.rot2.Rot2`. Group of two-dimensional orthogonal matrices with determinant +1, representing rotations in 2D space. Backed by a complex number. diff --git a/gen/python/sym/rot3.py b/gen/python/sym/rot3.py index a95967fb7..fdca681ed 100644 --- a/gen/python/sym/rot3.py +++ b/gen/python/sym/rot3.py @@ -15,7 +15,7 @@ class Rot3(object): """ - Autogenerated Python implementation of . + Autogenerated Python implementation of :py:class:`symforce.geo.rot3.Rot3`. Group of three-dimensional orthogonal matrices with determinant +1, representing rotations in 3D space. Backed by a quaternion with (x, y, z, w) storage. diff --git a/gen/python/sym/spherical_camera_cal.py b/gen/python/sym/spherical_camera_cal.py index f114283a1..f0cd04582 100644 --- a/gen/python/sym/spherical_camera_cal.py +++ b/gen/python/sym/spherical_camera_cal.py @@ -13,7 +13,7 @@ class SphericalCameraCal(object): """ - Autogenerated Python implementation of . + Autogenerated Python implementation of :py:class:`symforce.cam.spherical_camera_cal.SphericalCameraCal`. Kannala-Brandt camera model, where radial distortion is modeled relative to the 3D angle theta off the optical axis as opposed to radius within the image plane (i.e. ATANCamera) diff --git a/gen/python/sym/unit3.py b/gen/python/sym/unit3.py index 903f8e93a..86c6b0f17 100644 --- a/gen/python/sym/unit3.py +++ b/gen/python/sym/unit3.py @@ -17,7 +17,7 @@ class Unit3(object): """ - Autogenerated Python implementation of . + Autogenerated Python implementation of :py:class:`symforce.geo.unit3.Unit3`. Direction in R^3, represented as a :class:`Rot3 ` that transforms [0, 0, 1] to the desired direction. diff --git a/symforce/codegen/backends/cpp/templates/cam_package/CLASS.h.jinja b/symforce/codegen/backends/cpp/templates/cam_package/CLASS.h.jinja index e811ebc79..100a374d4 100644 --- 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 index d5d06a072..37d54a401 100644 --- 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 index 189e10fdf..f77e6e3f5 100644 --- 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 index a88358db6..65d10f572 100644 --- 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() }}