Begin syndyne documentation.

mkelley · Dec 8, 2023 · de277d0 · de277d0
1 parent 957b604
commit de277d0
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 6 deletions.
diff --git a/docs/sbpy/activity/dust/dynamics.rst b/docs/sbpy/activity/dust/dynamics.rst
@@ -0,0 +1,3 @@
+Dynamical models (`sbpy.activity.dust.dynamics`)
+================================================
+
diff --git a/docs/sbpy/activity/dust.rst → docs/sbpy/activity/dust/index.rst b/docs/sbpy/activity/dust.rst → docs/sbpy/activity/dust/index.rst
@@ -1,6 +1,12 @@
 Cometary dust (`sbpy.activity.dust`)
 ====================================
 
+Cometary dust is the refractory material released by comets.  This sub-module provides simple photometric models of cometary dust comae, and dynamical models for cometary dust grains.
+
+* `Photometric models: *Afρ* and *εfρ* <Afρ and εfρ models_>`_
+* :doc:`Syndynes <syndynes>`
+* :doc:`Dynamical models <dynamics>`
+
 
 *Afρ* and *εfρ* models
 ----------------------

diff --git a/docs/sbpy/activity/dust/syndynes.rst b/docs/sbpy/activity/dust/syndynes.rst
@@ -0,0 +1,11 @@
+Dust syndynes (`sbpy.activity.dust.syndynes`)
+=============================================
+
+.. toctree::
+    :maxdepth: 2
+
+
+Introduction
+------------
+
+Syndynes are the paths that dust grain test particles will follow after leaving the vicinity of a cometary nucleus.
diff --git a/docs/sbpy/activity/index.rst b/docs/sbpy/activity/index.rst
@@ -4,13 +4,14 @@ Activity Module (`sbpy.activity`)
 Introduction
 ------------
 
-`sbpy.activity` models cometary dust and gas activity.  It is separated into two main sub-modules: :doc:`dust` and :doc:`gas`.  The base module itself defines photometric apertures that may be useful for observations of comets.
+`sbpy.activity` models cometary dust and gas activity.  It is separated into two main sub-modules: :doc:`dust/index` and :doc:`gas`.  The base module itself defines photometric apertures that may be useful for observations of comets.
 
 .. toctree::
-   :maxdepth: 2
+  :maxdepth: 2
+  :caption: Table of Contents
 
-   dust.rst
-   gas.rst
+  dust/index
+  gas
 
 
 Apertures

diff --git a/sbpy/activity/dust/dynamics.py b/sbpy/activity/dust/dynamics.py
@@ -63,8 +63,7 @@ class State:
     t : `~astropy.time.Time`
         Time, a scalar or shape = (N,).
 
-    frame : `~astropy.coordinates.BaseCoordinateFrame` class or string,
-            optional
+    frame : `~astropy.coordinates.BaseCoordinateFrame` class or string, optional
         Coordinate frame for ``r`` and ``v``. Defaults to
         `~astropy.coordinates.HeliocentricEclipticIAU76` if given as ``None``.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		Dynamical models (`sbpy.activity.dust.dynamics`)
		================================================