Test doxygen/sphinx links#
Below some examples on how to write internal links to siconos objects in sphinx documents (rst).
Link to a siconos class or a struct:
Try to link to :class:`DynamicalSystem`
Result :
Try link to
DynamicalSystem
Link to a file (programs listing):
Try to link to :ref:`pgm_kernel_src_modelingTools_DynamicalSystem.hpp`
Result :
Try to link to Program listing for file kernel/src/modelingTools/DynamicalSystem.hpp
Link to a file (documentation):
Try to link to :ref:`file_kernel_src_modelingTools_DynamicalSystem.hpp`
Result :
Try to link to File kernel/src/modelingTools/DynamicalSystem.hpp
Link to a class method :
Try to link to :func:`Simulation::nextStep`
Result :
Try to link to
Simulation::nextStep()
Link to a function :
Try to link to :func:`cs_dl_norm`
Result :
Try to link to
cs_dl_norm()