Skip to content

Commit 3aa8dd8

Browse files
committed
updated docs and examples
1 parent 8b460ef commit 3aa8dd8

17 files changed

Lines changed: 21786 additions & 325 deletions
Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,20 @@
1+
********************************************************************************
2+
compas_assembly.algorithms
3+
********************************************************************************
14

2-
.. automodule:: compas_assembly.algorithms
5+
.. currentmodule:: compas_assembly.algorithms
6+
7+
8+
Functions
9+
=========
10+
11+
.. autosummary::
12+
:toctree: generated/
13+
:nosignatures:
14+
15+
assembly_hull
16+
assembly_hull_numpy
17+
assembly_interfaces
18+
assembly_interfaces_numpy
19+
mesh_mesh_interfaces
20+
merge_coplanar_interfaces

docs/api/compas_assembly.artists.rst

Lines changed: 0 additions & 2 deletions
This file was deleted.
Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,16 @@
1+
********************************************************************************
2+
compas_assembly.datastructures
3+
********************************************************************************
14

2-
.. automodule:: compas_assembly.datastructures
5+
.. currentmodule:: compas_assembly.datastructures
6+
7+
Classes
8+
=======
9+
10+
.. autosummary::
11+
:toctree: generated/
12+
:nosignatures:
13+
14+
Assembly
15+
Block
16+
Interface
Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,29 @@
1+
********************************************************************************
2+
compas_assembly.geometry
3+
********************************************************************************
14

2-
.. automodule:: compas_assembly.geometry
5+
.. currentmodule:: compas_assembly.geometry
6+
7+
Generate assemblies from geometry for well-known typologies.
8+
9+
10+
Base Classes
11+
============
12+
13+
.. autosummary::
14+
:toctree: generated/
15+
:nosignatures:
16+
17+
Geometry
18+
19+
20+
Classes
21+
=======
22+
23+
.. autosummary::
24+
:toctree: generated/
25+
:nosignatures:
26+
27+
Arch
28+
Dome
29+
Wall

docs/api/compas_assembly.rhino.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
1+
********************************************************************************
2+
compas_assembly.rhino
3+
********************************************************************************
4+
5+
.. currentmodule:: compas_assembly.rhino
6+
7+
Classes
8+
=======
9+
10+
.. autosummary::
11+
:toctree: generated/
12+
:nosignatures:
113

2-
.. automodule:: compas_assembly.rhino

docs/api/compas_assembly.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,16 @@
1+
********************************************************************************
2+
compas_assembly
3+
********************************************************************************
4+
5+
.. currentmodule:: compas_assembly
6+
7+
8+
.. toctree::
9+
:maxdepth: 1
10+
11+
compas_assembly.algorithms
12+
compas_assembly.datastructures
13+
compas_assembly.geometry
14+
compas_assembly.rhino
15+
compas_assembly.viewer
116

2-
.. automodule:: compas_assembly
Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,14 @@
1+
********************************************************************************
2+
compas_assembly.viewer
3+
********************************************************************************
14

2-
.. automodule:: compas_assembly.viewer
5+
.. currentmodule:: compas_assembly.viewer
6+
7+
Classes
8+
=======
9+
10+
.. autosummary::
11+
:toctree: generated/
12+
:nosignatures:
13+
14+
DEMViewer

0 commit comments

Comments
 (0)