Skip to content

Commit 0a5743f

Browse files
author
Moreno
committed
Add docs folder for documentation
1 parent ca3659a commit 0a5743f

File tree

9 files changed

+325
-0
lines changed

9 files changed

+325
-0
lines changed

‎famodel/docs/famodel.anchors.rst‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
famodel.anchors package
2+
=======================
3+
4+
Submodules
5+
----------
6+
7+
famodel.anchors.anchor module
8+
-----------------------------
9+
10+
.. automodule:: famodel.anchors.anchor
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
famodel.anchors.anchor\_capacity module
16+
---------------------------------------
17+
18+
.. automodule:: famodel.anchors.anchor_capacity
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
famodel.anchors.capacity\_dandg module
24+
--------------------------------------
25+
26+
.. automodule:: famodel.anchors.capacity_dandg
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
famodel.anchors.capacity\_drag module
32+
-------------------------------------
33+
34+
.. automodule:: famodel.anchors.capacity_drag
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
famodel.anchors.capacity\_load module
40+
-------------------------------------
41+
42+
.. automodule:: famodel.anchors.capacity_load
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
famodel.anchors.capacity\_plate module
48+
--------------------------------------
49+
50+
.. automodule:: famodel.anchors.capacity_plate
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
famodel.anchors.capacity\_screw module
56+
--------------------------------------
57+
58+
.. automodule:: famodel.anchors.capacity_screw
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
famodel.anchors.capacity\_suction module
64+
----------------------------------------
65+
66+
.. automodule:: famodel.anchors.capacity_suction
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
71+
famodel.anchors.capacity\_torpedo module
72+
----------------------------------------
73+
74+
.. automodule:: famodel.anchors.capacity_torpedo
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
78+
79+
Module contents
80+
---------------
81+
82+
.. automodule:: famodel.anchors
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:

‎famodel/docs/famodel.cables.rst‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
famodel.cables package
2+
======================
3+
4+
Submodules
5+
----------
6+
7+
famodel.cables.cable module
8+
---------------------------
9+
10+
.. automodule:: famodel.cables.cable
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
famodel.cables.cable\_properties module
16+
---------------------------------------
17+
18+
.. automodule:: famodel.cables.cable_properties
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
famodel.cables.components module
24+
--------------------------------
25+
26+
.. automodule:: famodel.cables.components
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
famodel.cables.dynamic\_cable module
32+
------------------------------------
33+
34+
.. automodule:: famodel.cables.dynamic_cable
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
famodel.cables.static\_cable module
40+
-----------------------------------
41+
42+
.. automodule:: famodel.cables.static_cable
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
Module contents
48+
---------------
49+
50+
.. automodule:: famodel.cables
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:

‎famodel/docs/famodel.mooring.rst‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
famodel.mooring package
2+
=======================
3+
4+
Submodules
5+
----------
6+
7+
famodel.mooring.connector module
8+
--------------------------------
9+
10+
.. automodule:: famodel.mooring.connector
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
famodel.mooring.mooring module
16+
------------------------------
17+
18+
.. automodule:: famodel.mooring.mooring
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
famodel.mooring.ontology2Mooring module
24+
---------------------------------------
25+
26+
.. automodule:: famodel.mooring.ontology2Mooring
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
Module contents
32+
---------------
33+
34+
.. automodule:: famodel.mooring
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:

‎famodel/docs/famodel.platform.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
famodel.platform package
2+
========================
3+
4+
Submodules
5+
----------
6+
7+
famodel.platform.platform module
8+
--------------------------------
9+
10+
.. automodule:: famodel.platform.platform
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: famodel.platform
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎famodel/docs/famodel.rst‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
famodel package
2+
===============
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
famodel.anchors
11+
famodel.cables
12+
famodel.mooring
13+
famodel.platform
14+
famodel.seabed
15+
famodel.substation
16+
famodel.turbine
17+
18+
Submodules
19+
----------
20+
21+
famodel.famodel\_base module
22+
----------------------------
23+
24+
.. automodule:: famodel.famodel_base
25+
:members:
26+
:undoc-members:
27+
:show-inheritance:
28+
29+
famodel.geography module
30+
------------------------
31+
32+
.. automodule:: famodel.geography
33+
:members:
34+
:undoc-members:
35+
:show-inheritance:
36+
37+
famodel.helpers module
38+
----------------------
39+
40+
.. automodule:: famodel.helpers
41+
:members:
42+
:undoc-members:
43+
:show-inheritance:
44+
45+
famodel.project module
46+
----------------------
47+
48+
.. automodule:: famodel.project
49+
:members:
50+
:undoc-members:
51+
:show-inheritance:
52+
53+
Module contents
54+
---------------
55+
56+
.. automodule:: famodel
57+
:members:
58+
:undoc-members:
59+
:show-inheritance:

‎famodel/docs/famodel.seabed.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
famodel.seabed package
2+
======================
3+
4+
Submodules
5+
----------
6+
7+
famodel.seabed.seabed\_tools module
8+
-----------------------------------
9+
10+
.. automodule:: famodel.seabed.seabed_tools
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: famodel.seabed
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎famodel/docs/famodel.substation.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
famodel.substation package
2+
==========================
3+
4+
Submodules
5+
----------
6+
7+
famodel.substation.substation module
8+
------------------------------------
9+
10+
.. automodule:: famodel.substation.substation
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: famodel.substation
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎famodel/docs/famodel.turbine.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
famodel.turbine package
2+
=======================
3+
4+
Submodules
5+
----------
6+
7+
famodel.turbine.turbine module
8+
------------------------------
9+
10+
.. automodule:: famodel.turbine.turbine
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: famodel.turbine
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎famodel/docs/modules.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
famodel
2+
=======
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
famodel

0 commit comments

Comments
 (0)