added modules to documentation

Countoscope · Sep 11, 2024 · eb523d4 · eb523d4
1 parent 75c3037
commit eb523d4
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 36 deletions.
diff --git a/countoscope b/countoscope
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -15,9 +15,7 @@ Indices and tables
 .. toctree::
    :maxdepth: 2
    :hidden:
-
-   modules/TRAJECTORY
-   modules/BOX
-   modules/SORTING
-   modules/COUNTOSCOPE
-   modules/UTILITIES
+
+   modules/trajectorytool
+   modules/boxcountingtool
+   modules/countoscope
diff --git a/docs/source/modules/BOX.rst b/docs/source/modules/BOX.rst
diff --git a/docs/source/modules/SORTING.rst b/docs/source/modules/SORTING.rst
diff --git a/docs/source/modules/TRAJECTORY.rst b/docs/source/modules/TRAJECTORY.rst
diff --git a/docs/source/modules/UTILITIES.rst b/docs/source/modules/UTILITIES.rst
diff --git a/docs/source/modules/boxcountingtool.rst b/docs/source/modules/boxcountingtool.rst
@@ -0,0 +1,7 @@
+Box Counting Tool
+=================
+
+.. automodule:: countoscope.boxcountingtool
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/modules/COUNTOSCOPE.rst → docs/source/modules/countoscope.rst b/docs/source/modules/COUNTOSCOPE.rst → docs/source/modules/countoscope.rst
@@ -1,7 +1,7 @@
 Countoscope
 ===========
 
-.. automodule:: countoscope.Countoscope
+.. automodule:: countoscope.countoscope
     :members:
     :undoc-members:
     :show-inheritance:
diff --git a/docs/source/modules/trajectorytool.rst b/docs/source/modules/trajectorytool.rst
@@ -0,0 +1,7 @@
+Trajectory Tool
+===============
+
+.. automodule:: countoscope.trajectorytool
+    :members:
+    :undoc-members:
+    :show-inheritance:
+0 −38		.github/workflow/python-app.yml
+39 −0		.github/workflows/python-app.yml
+2 −1		.gitignore
+1 −0		.gitmodules
+59 −16		README.rst
+1 −0		countoscope/__init__.py
+57 −13		countoscope/boxcountingtool.py
+12 −8		countoscope/countoscope.py
+0 −69		countoscope/sorting.py
+4 −5		countoscope/trajectorytool.py
+30 −2		countoscope/utilities.py
+1 −1		datasets
+92 −0		examples/example_xyz.py
+6,321 −0		examples/trajectory.xyz
+0 −1		requirements.txt
+1 −0		tests/requirements.txt
+31 −0		tests/test_converter.py
+21 −27		tests/test_ideal_cases.py