search

moorepants / learn-multibody-dynamics

Interactive computational book on multibody dynamics
https://moorepants.github.io/learn-multibody-dynamics/
Other
123 stars 29 forks source link

Cross reference all functions, methods, and class from external libraries (SymPy, NumPy, etc.) #23

Closed moorepants closed 1 year ago

moorepants commented 2 years ago

We should make all methods of variables, classes, attributes, functions, and methods link to the SymPy documenation API reference (if that exists). The syntax is:

:external:py:meth:`~sympy.physics.vector.frame.ReferenceFrame.ang_acc_in`
:external:py:class:`~sympy.physics.vector.frame.ReferenceFrame`
:external:py:func:`~sympy.physics.vector.functions.cross`
moorepants commented 2 years ago

Some current errors:

/home/runner/work/learn-multibody-dynamics/learn-multibody-dynamics/sympy.rst:93: WARNING: external py:class reference target not found: sympy.core.function.UndefinedFunction
/home/runner/work/learn-multibody-dynamics/learn-multibody-dynamics/sympy.rst:203: WARNING: external py:func reference target not found: sympy.functions.elementary.trigonometric.sin
/home/runner/work/learn-multibody-dynamics/learn-multibody-dynamics/sympy.rst:273: WARNING: external py:func reference target not found: sympy.printing.pretty.pretty.pprint
/home/runner/work/learn-multibody-dynamics/learn-multibody-dynamics/sympy.rst:400: WARNING: external py:func reference target not found: sympy.core.evalf.evalf
/home/runner/work/learn-multibody-dynamics/learn-multibody-dynamics/sympy.rst:471: WARNING: external py:class reference target not found: sympy.matrices.dense.Matrix
/home/runner/work/learn-multibody-dynamics/learn-multibody-dynamics/sympy.rst:526: WARNING: external py:func reference target not found: sympy.matrices.expressions.hadamard.hadamard_product
/home/runner/work/learn-multibody-dynamics/learn-multibody-dynamics/sympy.rst:549: WARNING: external py:meth reference target not found: sympy.matrices.matrices.Matrix.jacobian
/home/runner/work/learn-multibody-dynamics/learn-multibody-dynamics/sympy.rst:666: WARNING: external py:meth reference target not found: sympy.matrices.matrices.Matrix.LUsolve
moorepants commented 2 years ago

Recent warnings:

/home/moorepants/Manuscripts/learn-multibody-dynamics/differentiation.rst:286: WARNING: external py:func reference target not found: sympy.physics.vector.functions.dynamicsymbols
/home/moorepants/Manuscripts/learn-multibody-dynamics/motion.rst:454: WARNING: undefined label: fig-snakeboard-configuration
/home/moorepants/Manuscripts/learn-multibody-dynamics/orientation.rst:21: WARNING: term not in glossary: reference frame
/home/moorepants/Manuscripts/learn-multibody-dynamics/orientation.rst:235: WARNING: term not in glossary: direction cosine matrix
/home/moorepants/Manuscripts/learn-multibody-dynamics/simulation.rst:248: WARNING: external py:func reference target not found: numpy.deg2rad
/home/moorepants/Manuscripts/learn-multibody-dynamics/simulation.rst:248: WARNING: external py:func reference target not found: numpy.rad2deg
/home/moorepants/Manuscripts/learn-multibody-dynamics/simulation.rst:470: WARNING: external py:func reference target not found: sympy.physics.vector.printing.mlatex
/home/moorepants/Manuscripts/learn-multibody-dynamics/sympy.rst:93: WARNING: external py:class reference target not found: sympy.core.function.UndefinedFunction
/home/moorepants/Manuscripts/learn-multibody-dynamics/sympy.rst:528: WARNING: external py:func reference target not found: sympy.matrices.expressions.hadamard.hadamard_product
/home/moorepants/Manuscripts/learn-multibody-dynamics/sympy.rst:551: WARNING: external py:meth reference target not found: sympy.matrices.matrices.DenseMatrix.jacobian
/home/moorepants/Manuscripts/learn-multibody-dynamics/sympy.rst:670: WARNING: external py:meth reference target not found: sympy.matrices.matrices.MutableDenseMatrix.LUsolve
/home/moorepants/Manuscripts/learn-multibody-dynamics/vectors.rst:584: WARNING: undefined label: vector-function
moorepants commented 2 years ago

Almost all of the pythreejs cross references aren't working on the 3d viz page. I'm not sure why. The AnimationAction works but none of the others.

moorepants commented 2 years ago

Current set of cross reference warnings:

/home/moorepants/Manuscripts/learn-multibody-dynamics/holonomic-eom.rst:186: WARNING: external py:func reference target not found: sympy.trigsimp
/home/moorepants/Manuscripts/learn-multibody-dynamics/simulation.rst:256: WARNING: external py:func reference target not found: numpy.deg2rad
/home/moorepants/Manuscripts/learn-multibody-dynamics/simulation.rst:256: WARNING: external py:func reference target not found: numpy.rad2deg
/home/moorepants/Manuscripts/learn-multibody-dynamics/sympy.rst:93: WARNING: external py:class reference target not found: sympy.core.function.UndefinedFunction
/home/moorepants/Manuscripts/learn-multibody-dynamics/sympy.rst:526: WARNING: external py:func reference target not found: sympy.matrices.expressions.hadamard.hadamard_product
/home/moorepants/Manuscripts/learn-multibody-dynamics/visualization.rst:240: WARNING: external py:class reference target not found: py3js.geometries.CylinderGeometry
/home/moorepants/Manuscripts/learn-multibody-dynamics/visualization.rst:254: WARNING: external py:class reference target not found: py3js.Mesh
/home/moorepants/Manuscripts/learn-multibody-dynamics/visualization.rst:254: WARNING: external py:class reference target not found: py3js.Material
/home/moorepants/Manuscripts/learn-multibody-dynamics/visualization.rst:270: WARNING: external py:class reference target not found: py3js.AxesHelper()
/home/moorepants/Manuscripts/learn-multibody-dynamics/visualization.rst:270: WARNING: external py:attr reference target not found: py3js.Mesh.position
/home/moorepants/Manuscripts/learn-multibody-dynamics/visualization.rst:285: WARNING: external py:class reference target not found: py3js.Scene
/home/moorepants/Manuscripts/learn-multibody-dynamics/visualization.rst:285: WARNING: external py:class reference target not found: py3js.Renderer
/home/moorepants/Manuscripts/learn-multibody-dynamics/visualization.rst:285: WARNING: external py:class reference target not found: py3js.OrbitControls
/home/moorepants/Manuscripts/learn-multibody-dynamics/visualization.rst:337: WARNING: external py:attr reference target not found: py3js.Mesh.matrix
/home/moorepants/Manuscripts/learn-multibody-dynamics/visualization.rst:355: WARNING: external py:meth reference target not found: numpy.reshape
/home/moorepants/Manuscripts/learn-multibody-dynamics/visualization.rst:355: WARNING: external py:meth reference target not found: numpy.flatten
/home/moorepants/Manuscripts/learn-multibody-dynamics/visualization.rst:483: WARNING: external py:attr reference target not found: py3js.Mesh.matrixAutoUpdate
/home/moorepants/Manuscripts/learn-multibody-dynamics/visualization.rst:553: WARNING: external py:class reference target not found: py3js.VectorKeyframeTrack
moorepants commented 2 years ago

Fixed remaining warnings with https://github.com/moorepants/learn-multibody-dynamics/commit/fc60818ad1505b8113d24aba1f2b1eb5c56ebe70

Only need to make sure all new function, method, and class uses do cross reference.

moorepants commented 1 year ago

I'm not getting any warnings in the ba3eab75c914c483224dcd697c200cd4f41ae09c build. So closing.