File: howto_doc.rst

package info (click to toggle)
siconos 4.3.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 82,496 kB
  • sloc: cpp: 159,693; ansic: 108,665; fortran: 33,248; python: 20,709; xml: 1,244; sh: 385; makefile: 226
file content (60 lines) | stat: -rw-r--r-- 1,119 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
.. _howto:


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:

  .. code-block:: rst
		  
     Try to link to :class:`DynamicalSystem`

  **Result** : 
      
  Try link to :class:`DynamicalSystem`


* Link to a file (programs listing): 

  .. code-block:: rst

     Try to link to :ref:`pgm_kernel_src_modelingTools_DynamicalSystem.hpp`
      
  **Result** : 

  Try to link to :ref:`pgm_kernel_src_modelingTools_DynamicalSystem.hpp`

* Link to a file (documentation): 

  .. code-block:: rst

     Try to link to :ref:`file_kernel_src_modelingTools_DynamicalSystem.hpp`
      
  **Result** : 

  Try to link to :ref:`file_kernel_src_modelingTools_DynamicalSystem.hpp`


* Link to a class method : 

  .. code-block:: rst

     Try to link to :func:`Simulation::nextStep`

  **Result** :

  Try to link to :func:`Simulation::nextStep`


* Link to a function : 

  .. code-block:: rst

     Try to link to :func:`cs_dl_norm`

  **Result** :

  Try to link to :func:`cs_dl_norm`