Updated docs

arpastrana · Jun 3, 2022 · 5e1611a · 5e1611a
1 parent be63a21
commit 5e1611a
Show file tree

Hide file tree

Showing 12 changed files with 26 additions and 7 deletions.
diff --git a/docs/_images/01_quick_start.png b/docs/_images/01_quick_start.png
diff --git a/docs/_images/02_braced_tower_2d.png b/docs/_images/02_braced_tower_2d.png
diff --git a/docs/_images/03_bridge_2d.png b/docs/_images/03_bridge_2d.png
diff --git a/docs/_images/04_tree_2d.png b/docs/_images/04_tree_2d.png
diff --git a/docs/_images/05_tensegrity_wheel_2d.png b/docs/_images/05_tensegrity_wheel_2d.png
diff --git a/docs/api/compas_cem.viewers.rst b/docs/api/compas_cem.viewers.rst
@@ -0,0 +1 @@
+.. automodule:: compas_cem.viewers
diff --git a/examples/01_quick_start.py b/examples/01_quick_start.py
@@ -74,7 +74,7 @@
 
 # add shifted form diagram to the scene
 form = form.transformed(Translation.from_vector([0.0, -1.0, 0.0]))
-plotter.add(form, nodesize=0.2)
+plotter.add(form, nodesize=0.2, show_edgetext=True, edgetext="force")
 
 # show plotter contents
 plotter.zoom_extents()

diff --git a/src/compas_cem/__init__.py b/src/compas_cem/__init__.py
@@ -16,6 +16,7 @@
     compas_cem.equilibrium
     compas_cem.optimization
     compas_cem.plotters
+    compas_cem.viewers
 """
 
 from __future__ import print_function

diff --git a/src/compas_cem/plotters/__init__.py b/src/compas_cem/plotters/__init__.py
@@ -5,7 +5,7 @@
 .. currentmodule:: compas_cem.plotters
 
 
-Classes
+Artists
 =======
 
 .. autosummary::
@@ -14,6 +14,15 @@
 
     FormArtist
     TopologyArtist
+
+Plotters
+========
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    Plotter
 """
 
 from __future__ import absolute_import

diff --git a/src/compas_cem/viewers/__init__.py b/src/compas_cem/viewers/__init__.py
@@ -5,8 +5,8 @@
 .. currentmodule:: compas_cem.viewers
 
 
-Classes
-=======
+Visualization objects
+=====================
 
 .. autosummary::
     :toctree: generated/
@@ -15,6 +15,15 @@
     DiagramObject
     FormDiagramObject
     TopologyDiagramObject
+
+Viewers
+=======
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    Viewer
 """
 
 from __future__ import absolute_import
@@ -25,7 +34,6 @@
 def is_compasviewers_installed():
     try:
         import compas_view2  # noqa F401
-
     except ImportError:
         return False
     return True

diff --git a/src/compas_cem/viewers/formobject.py b/src/compas_cem/viewers/formobject.py
@@ -12,7 +12,7 @@ class FormDiagramObject(DiagramObject):
     """
     An object to display a form diagram.
 
-    Parameter
+    Parameters
     ----------
     form_diagram : :class:`~compas_cem.diagrams.FormDiagram`
         The form diagram to plot.

diff --git a/src/compas_cem/viewers/topologyobject.py b/src/compas_cem/viewers/topologyobject.py
@@ -12,7 +12,7 @@ class TopologyDiagramObject(DiagramObject):
     """
     An object to display a topology diagram.
 
-    Parameter
+    Parameters
     ----------
     form_diagram : :class:`~compas_cem.diagrams.TopologyDiagram`
         The form diagram to plot.