Document HOOMD data structure types

glotzerlab · Nov 17, 2020 · 1a9fb3d · 1a9fb3d
1 parent 408ac0a
commit 1a9fb3d
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/sphinx-doc/module-hoomd-data-structures.rst b/sphinx-doc/module-hoomd-data-structures.rst
@@ -0,0 +1,19 @@
+hoomd.data.data_structures
+--------------------------
+
+.. py:currentmodule:: hoomd.data.data_structures
+
+.. rubric:: Overview
+
+.. autosummary::
+    :nosignatures:
+
+    HOOMDDict
+    HOOMDList
+    HOOMDSet
+
+.. rubric:: Details
+
+.. automodule:: hoomd.data.data_structures
+    :synopsis: Basic HOOMD data structures.
+    :members: HOOMDDict, HOOMDList, HOOMDSet
diff --git a/sphinx-doc/module-hoomd-data.rst b/sphinx-doc/module-hoomd-data.rst
@@ -47,3 +47,4 @@ hoomd.data
    :maxdepth: 3
 
    module-hoomd-array
+   module-hoomd-data-structures
Original file line number	Diff line number	Diff line change
Expand Up		@@ -47,3 +47,4 @@ hoomd.data
		:maxdepth: 3

		module-hoomd-array
		module-hoomd-data-structures