Tweaks to new docs and clean up

jobovy · Sep 13, 2024 · dfb99ae · dfb99ae
1 parent 62f2208
commit dfb99ae
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 17 deletions.
diff --git a/doc/source/images/streamspraydf-b14-xz-wstreamdf.png b/doc/source/images/streamspraydf-b14-xz-wstreamdf.png
diff --git a/doc/source/reference/df.rst b/doc/source/reference/df.rst
@@ -348,5 +348,13 @@ General instance routines
 .. toctree::
    :maxdepth: 1
 
-   __init__ <streamspraydf.rst>
    sample <streamspraydfsample.rst>
+
+Specific particle-spray models
++++++++++++++++++++++++++++++++
+
+.. toctree::
+   :maxdepth: 1
+
+   Chen et al. (2024) <streamspraydfchen24.rst>
+   Fardal et al. (2015) <streamspraydffardal15.rst>
diff --git a/doc/source/reference/streamspraydf.rst b/doc/source/reference/streamspraydf.rst
diff --git a/doc/source/reference/streamspraydfchen24.rst b/doc/source/reference/streamspraydfchen24.rst
@@ -0,0 +1,5 @@
+The particle-spray stream DF using Chen et al. (2024) formalism
+===============================================================
+
+.. autoclass:: galpy.df.chen24spraydf
+   :members: __init__
diff --git a/doc/source/reference/streamspraydffardal15.rst b/doc/source/reference/streamspraydffardal15.rst
@@ -0,0 +1,7 @@
+.. _api_streamspraydf:
+
+The particle-spray stream DF using Fardal et al. (2015) formalism
+==================================================================
+
+.. autoclass:: galpy.df.fardal15spraydf
+   :members: __init__
diff --git a/doc/source/streamdf.rst b/doc/source/streamdf.rst
@@ -525,8 +525,8 @@ we give a simple example of the the two methods.
 
 .. note::
    ``fardal15spraydf`` was previously known as ``streamspraydf`` before
-   version ``v1.10.1``. While the old name is still supported for backward
-   compatibility, it is recommended to use the new name ``fardal15spraydf``.
+   version ``v1.10.1``. While the old name is still supported  until ``v.1.11.0``
+   for backward compatibility, we recommend using the new name ``fardal15spraydf``.
 
 Like in the ``streamdf`` example above, we use the same orbit, potential, and
 cluster mass as in

diff --git a/galpy/df/streamspraydf.py b/galpy/df/streamspraydf.py
@@ -392,8 +392,8 @@ def __init__(
         vo=None,
     ):
         """
-        Initialize a Chen+24 stream spray DF model of a tidal stream
-        https://ui.adsabs.harvard.edu/abs/2024arXiv240801496C/abstract
+        Initialize a `Chen et al. (2024) <https://ui.adsabs.harvard.edu/abs/2024arXiv240801496C/abstract>`_ stream spray DF model of a tidal stream.
+
 
         Parameters
         ----------
@@ -530,8 +530,8 @@ def __init__(
         vo=None,
     ):
         """
-        Initialize a Fardal+15 stream spray DF model of a tidal stream
-        https://ui.adsabs.harvard.edu/abs/2014arXiv1410.1861F/abstract
+        Initialize a `Fardal et al. (2015) <https://ui.adsabs.harvard.edu/abs/2014arXiv1410.1861F/abstract>`_ stream spray DF model of a tidal stream.
+
 
         Parameters
         ----------