Skip to content

Commit feba054

Browse files
Update documentation.
1 parent 4b774ef commit feba054

File tree

5 files changed

+12
-32
lines changed

5 files changed

+12
-32
lines changed

docs/src/Core/Rendering/api.rst

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,17 @@
11
API
22
===
33

4-
UserAPI
5-
-------
64

7-
.. autoclass:: SSD.Core.Rendering.UserAPI.UserAPI
5+
.. autoclass:: SSD.Core.Rendering.user_api.UserAPI
86
:special-members: __init__
97
:members:
108

119

12-
Visualizer
13-
----------
14-
15-
.. autoclass:: SSD.Core.Rendering.Visualizer.Visualizer
10+
.. autoclass:: SSD.Core.Rendering.visualizer.Visualizer
1611
:special-members: __init__
1712
:members:
1813

1914

20-
Replay
21-
------
22-
23-
.. autoclass:: SSD.Core.Rendering.Replay.Replay
15+
.. autoclass:: SSD.Core.Rendering.replay.Replay
2416
:special-members: __init__
2517
:members:

docs/src/Core/Storage/api.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
API
22
===
33

4-
Database
5-
--------
64

7-
.. autoclass:: SSD.Core.Storage.Database.Database
5+
.. autoclass:: SSD.Core.Storage.database.Database
86
:special-members: __init__
97
:members:
108

docs/src/SOFA/api.rst

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,26 @@ API
44
Storage
55
-------
66

7-
Database
8-
""""""""
97

10-
.. autoclass:: SSD.SOFA.Storage.Database.Database
8+
.. autoclass:: SSD.SOFA.Storage.database.Database
119
:special-members: __init__
1210
:members:
1311

1412

1513
Rendering
1614
---------
1715

18-
UserAPI
19-
"""""""
2016

21-
.. autoclass:: SSD.SOFA.Rendering.UserAPI.UserAPI
17+
.. autoclass:: SSD.SOFA.Rendering.user_api.UserAPI
2218
:special-members: __init__
2319
:members:
2420

2521

26-
Visualizer
27-
""""""""""
28-
29-
.. autoclass:: SSD.SOFA.Rendering.Visualizer.Visualizer
22+
.. autoclass:: SSD.SOFA.Rendering.visualizer.Visualizer
3023
:special-members: __init__
3124
:members:
3225

3326

34-
Replay
35-
""""""
36-
37-
.. autoclass:: SSD.SOFA.Rendering.Replay.Replay
27+
.. autoclass:: SSD.SOFA.Rendering.replay.Replay
3828
:special-members: __init__
3929
:members:

docs/src/SOFA/rendering.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ It is also possible to create and update objects manually such as in the ``Core`
4646
.. code-block:: python
4747
4848
import Sofa
49-
from SSD.SOFA import UserAPI
49+
from SSD.SOFA.Rendering import UserAPI
5050
5151
# Create the root node
5252
root = Sofa.Core.Node('root')
@@ -87,7 +87,7 @@ It is also possible to create and update objects manually such as in the ``Core`
8787

8888
.. code-block:: python
8989
90-
from SSD.SOFA import UserAPI
90+
from SSD.SOFA.Rendering import UserAPI
9191
9292
def createScene(root):
9393

docs/src/SOFA/storage.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Adding callbacks is very simple, since you only have to specify:
3838
.. code-block:: python
3939
4040
import Sofa
41-
from SSD.SOFA import Database
41+
from SSD.SOFA.Storage import Database
4242
4343
# Create the root node
4444
root = Sofa.Core.Node('root')
@@ -76,7 +76,7 @@ Adding callbacks is very simple, since you only have to specify:
7676

7777
.. code-block:: python
7878
79-
from SSD.SOFA import Database
79+
from SSD.SOFA.Storage import Database
8080
8181
def createScene(root):
8282

0 commit comments

Comments
 (0)