Skip to content

Commit 194b11b

Browse files
tomvanmeletomvanmele
committed
no signatures for the autogenerated oerview tables
1 parent 68e9c8a commit 194b11b

File tree

11 files changed

+67
-13
lines changed

11 files changed

+67
-13
lines changed

‎src/compas/com/__init__.py‎

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,28 +16,19 @@
1616
1717
.. autosummary::
1818
:toctree: generated/
19+
:nosignatures:
1920
2021
MatlabClient
2122
MatlabEngine
2223
MatlabProcess
2324
MatlabSession
2425
25-
26-
============= ============
27-
Interface Case
28-
============= ============
29-
MatlabClient Operating system is Windows. Matlab version is older than 2014b.
30-
MatlabProcess Operating system is not Windows. Matlab version is older than 2014b.
31-
MatlabEngine All operating systems. Matlab version is 2014b or above. No shared Matlab session is available.
32-
MatlabSession All operating systems. Matlab version is 2014b or above. A shared Matlab session is already available.
33-
============= ============
34-
35-
3626
ssh
3727
===
3828
3929
.. autosummary::
4030
:toctree: generated/
31+
:nosignatures:
4132
4233
connect_to_server
4334
local_command

‎src/compas/datastructures/__init__.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
1111
.. autosummary::
1212
:toctree: generated/
13+
:nosignatures:
1314
1415
Mesh
1516
Network

‎src/compas/files/__init__.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
2525
.. autosummary::
2626
:toctree: generated/
27+
:nosignatures:
2728
2829
DXF
2930
DXFReader
@@ -43,6 +44,7 @@
4344
4445
.. autosummary::
4546
:toctree: generated/
47+
:nosignatures:
4648
4749
OBJ
4850
OBJReader
@@ -56,6 +58,7 @@
5658
5759
.. autosummary::
5860
:toctree: generated/
61+
:nosignatures:
5962
6063
PLYreader
6164

‎src/compas/geometry/__init__.py‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
3030
.. autosummary::
3131
:toctree: generated/
32+
:nosignatures:
3233
3334
bestfit_plane
3435
bestfit_plane_numpy
@@ -67,6 +68,7 @@
6768
6869
.. autosummary::
6970
:toctree: generated/
71+
:nosignatures:
7072
7173
Vector
7274
Point
@@ -82,6 +84,7 @@
8284
8385
.. autosummary::
8486
:toctree: generated/
87+
:nosignatures:
8588
8689
KDTree
8790
@@ -91,6 +94,7 @@
9194
9295
.. autosummary::
9396
:toctree: generated/
97+
:nosignatures:
9498
9599
add_vectors
96100
add_vectors_xy
@@ -132,6 +136,7 @@
132136
133137
.. autosummary::
134138
:toctree: generated/
139+
:nosignatures:
135140
136141
vector_from_points
137142
vector_from_points_xy
@@ -146,6 +151,7 @@
146151
147152
.. autosummary::
148153
:toctree: generated/
154+
:nosignatures:
149155
150156
closest_point_in_cloud
151157
closest_point_in_cloud_xy
@@ -176,6 +182,7 @@
176182
177183
.. autosummary::
178184
:toctree: generated/
185+
:nosignatures:
179186
180187
angle_smallest_points
181188
angle_smallest_points_xy
@@ -199,6 +206,7 @@
199206
200207
.. autosummary::
201208
:toctree: generated/
209+
:nosignatures:
202210
203211
center_of_mass_polygon
204212
center_of_mass_polygon_xy
@@ -215,6 +223,7 @@
215223
216224
.. autosummary::
217225
:toctree: generated/
226+
:nosignatures:
218227
219228
normal_polygon
220229
normal_triangle
@@ -225,6 +234,7 @@
225234
226235
.. autosummary::
227236
:toctree: generated/
237+
:nosignatures:
228238
229239
is_ccw_xy
230240
is_colinear
@@ -259,6 +269,7 @@
259269
260270
.. autosummary::
261271
:toctree: generated/
272+
:nosignatures:
262273
263274
intersection_circle_circle
264275
intersection_circle_circle_xy
@@ -277,6 +288,7 @@
277288
278289
.. autosummary::
279290
:toctree: generated/
291+
:nosignatures:
280292
281293
area_polygon
282294
area_polygon_xy
@@ -289,12 +301,14 @@
289301
290302
.. autosummary::
291303
:toctree: generated/
304+
:nosignatures:
292305
293306
transform
294307
transform_numpy
295308
296309
.. autosummary::
297310
:toctree: generated/
311+
:nosignatures:
298312
299313
homogenize
300314
dehomogenize
@@ -306,6 +320,7 @@
306320
307321
.. autosummary::
308322
:toctree: generated/
323+
:nosignatures:
309324
310325
projection_matrix
311326
rotation_matrix
@@ -315,6 +330,7 @@
315330
316331
.. autosummary::
317332
:toctree: generated/
333+
:nosignatures:
318334
319335
mirror_point_line
320336
mirror_point_line_xy

‎src/compas/hpc/__init__.py‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,26 @@
66
77
.. module:: compas.hpc
88
9-
109
.. warning::
1110
1211
The functionality of this package is experimental and subject to frequent change.
1312
For now, don't use it for anything important :)
1413
14+
.. note::
15+
16+
The HPC package id built around Numba, PyCuda and PyOpenCL
17+
18+
* Numba: https://numba.pydata.org/
19+
* PyCuda: https://mathema.tician.de/software/pycuda/
20+
* PyOpenCL: https://mathema.tician.de/software/pyopencl/
21+
1522
1623
algorithms
1724
==========
1825
1926
.. autosummary::
2027
:toctree: generated/
28+
:nosignatures:
2129
2230
drx_numba
2331
@@ -27,6 +35,7 @@
2735
2836
.. autosummary::
2937
:toctree: generated/
38+
:nosignatures:
3039
3140
sum_vectors_numba
3241
norm_vector_numba
@@ -78,13 +87,15 @@
7887
7988
.. autosummary::
8089
:toctree: generated/
90+
:nosignatures:
8191
8292
8393
euler
8494
-----
8595
8696
.. autosummary::
8797
:toctree: generated/
98+
:nosignatures:
8899
89100
core.euler.connect_to_euler
90101
core.euler.load_euler_module
@@ -105,13 +116,15 @@
105116
106117
.. autosummary::
107118
:toctree: generated/
119+
:nosignatures:
108120
109121
110122
opencl
111123
------
112124
113125
.. autosummary::
114126
:toctree: generated/
127+
:nosignatures:
115128
116129
117130
"""

‎src/compas/interop/__init__.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,13 @@
1818
1919
.. autosummary::
2020
:toctree: generated/
21+
:nosignatures:
2122
2223
shapeop.ShapeOpSolver
2324
2425
.. autosummary::
2526
:toctree: generated/
27+
:nosignatures:
2628
2729
shapeop.int_array
2830
shapeop.float_array
@@ -33,6 +35,7 @@
3335
3436
.. autosummary::
3537
:toctree: generated/
38+
:nosignatures:
3639
3740
core.cpp.xdarray.Array1D
3841
core.cpp.xdarray.Array2D

‎src/compas/numerical/__init__.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@
66
77
.. module:: compas.numerical
88
9+
.. note::
10+
11+
The array and matrix-based implementations of the numerical package are built around NumPy and SciPy.
12+
13+
* NumPy: http://www.numpy.org/
14+
* SciPy: https://www.scipy.org/
15+
916
1017
Algorithms
1118
==========

‎src/compas/plotters/__init__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,10 @@
1212
1313
* Matplotlib: https://matplotlib.org/
1414
15+
1516
.. autosummary::
1617
:toctree: generated/
18+
:nosignatures:
1719
1820
Plotter
1921
NetworkPlotter

‎src/compas/topology/__init__.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
1414
.. autosummary::
1515
:toctree: generated/
16+
:nosignatures:
1617
1718
vertex_coloring
1819
@@ -21,6 +22,7 @@
2122
2223
.. autosummary::
2324
:toctree: generated/
25+
:nosignatures:
2426
2527
mesh_flip_cycles
2628
mesh_unify_cycles
@@ -30,6 +32,7 @@
3032
3133
.. autosummary::
3234
:toctree: generated/
35+
:nosignatures:
3336
3437
network_is_crossed
3538
network_count_crossings
@@ -44,6 +47,7 @@
4447
4548
.. autosummary::
4649
:toctree: generated/
50+
:nosignatures:
4751
4852
mesh_subdivide
4953
mesh_subdivide_tri
@@ -55,6 +59,7 @@
5559
5660
.. autosummary::
5761
:toctree: generated/
62+
:nosignatures:
5863
5964
depth_first_ordering
6065
depth_first_tree
@@ -70,6 +75,7 @@
7075
7176
.. autosummary::
7277
:toctree: generated/
78+
:nosignatures:
7379
7480
delaunay_from_points
7581
voronoi_from_delaunay

0 commit comments

Comments
 (0)