Skip to content

Handle inline tags that span multiple lines #5

@virtuald

Description

@virtuald

Used to work, but it's broken now:

$ sphinxify
/**
 * Constructs a control-affine plant inversion model-based feedforward from
 * given model dynamics.
 *
 * If given the vector valued function as f(x, u) where x is the state
 * vector and u is the input vector, the B matrix(continuous input matrix)
 * is calculated through a NumericalJacobian. In this case f has to be
 * control-affine (of the form f(x) + Bu).
 *
 * The feedforward is calculated as
 * <strong> u_ff = B<sup>+</sup> (rDot - f(x)) </strong>, where <strong>
 * B<sup>+</sup> </strong> is the pseudoinverse of B.
 *
 * This feedforward does not account for a dynamic B matrix, B is either
 * determined or supplied when the feedforward is created and remains constant.
 *
 * For more on the underlying math, read
 * https://file.tavsys.net/control/controls-engineering-in-frc.pdf.
 */

        """Constructs a control-affine plant inversion model-based feedforward from
        given model dynamics.

        If given the vector valued function as f(x, u) where x is the state
        vector and u is the input vector, the B matrix(continuous input matrix)
        is calculated through a NumericalJacobian. In this case f has to be
        control-affine (of the form f(x) + Bu).

        The feedforward is calculated as
        ** u_ff = B<sup>+</sup> (rDot - f(x)) **, where **
        B<sup>+</sup> ** is the pseudoinverse of B.

        This feedforward does not account for a dynamic B matrix, B is either
        determined or supplied when the feedforward is created and remains constant.

        For more on the underlying math, read
        https://file.tavsys.net/control/controls-engineering-in-frc.pdf.
        """
...

docstring of wpimath._controls._controls.controller.ControlAffinePlantInversionFeedforward_1_1:9: WARNING: Inline strong start-string without end-string.
docstring of wpimath._controls._controls.controller.ControlAffinePlantInversionFeedforward_2_1:9: WARNING: Inline strong start-string without end-string.
docstring of wpimath._controls._controls.controller.ControlAffinePlantInversionFeedforward_2_2:9: WARNING: Inline strong start-string without end-string.
docstring of wpimath._controls._controls.controller.LinearPlantInversionFeedforward_1_1:3: WARNING: Inline strong start-string without end-string.
docstring of wpimath._controls._controls.controller.LinearPlantInversionFeedforward_2_1:3: WARNING: Inline strong start-string without end-string.
docstring of wpimath._controls._controls.controller.LinearPlantInversionFeedforward_2_2:3: WARNING: Inline strong start-string without end-string.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions