added ms conversion documentation

conversion/__init__.py

@@ -1,2 +1,7 @@
 # __init__.py
 from .ms_to_pq import ms_to_pq
+from .asdm_to_pq import asdm_to_pq
+from .fits_to_pq import fits_to_pq
+from .pq_to_ms import pq_to_ms
+from .pq_to_asdm import pq_to_asdm
+from .pq_to_fits import pq_to_fits

conversion/asdm_to_pq.py

@@ -0,0 +1,21 @@
+def asdm_to_pq(infile, outfile=None):
+    """
+    .. todo::
+        This function is not yet implemented
+    
+    Convert ASDM format to Apache Parquet format (future)
+
+    Parameters
+    ----------
+    infile : str
+        Input ASDM filename
+    outfile : str
+        Output Parquet filename. If None, will use infile name with .pq extension
+
+    Returns
+    -------
+    bool
+        Success status
+    """
+    return True
+

conversion/fits_to_pq.py

@@ -0,0 +1,21 @@
+def fits_to_pq(infile, outfile=None):
+    """
+    .. todo::
+        This function is not yet implemented
+    
+    Convert FITS format MS to Apache Parquet format (future)
+
+    Parameters
+    ----------
+    infile : str
+        Input FITS filename
+    outfile : str
+        Output Parquet filename. If None, will use infile name with .pq extension
+
+    Returns
+    -------
+    bool
+        Success status
+    """
+    return True
+

conversion/ms_to_pq.py

@@ -1,5 +1,8 @@
 def ms_to_pq(infile, outfile=None):
     """
+    .. todo::
+        This function is not yet implemented
+    
     Convert Legacy MS to Apache Parquet format
 
     Parameters

conversion/pq_to_asdm.py

@@ -0,0 +1,21 @@
+def pq_to_asdm(infile, outfile=None):
+    """
+    .. todo::
+        This function is not yet implemented
+    
+    Convert Apache Parquet MS to ASDM format (future)
+
+    Parameters
+    ----------
+    infile : str
+        Input Parquet filename
+    outfile : str
+        Output ASDM filename. If None, will use infile name with .asdm extension
+
+    Returns
+    -------
+    bool
+        Success status
+    """
+    return True
+

conversion/pq_to_fits.py

@@ -0,0 +1,21 @@
+def pq_to_fits(infile, outfile=None):
+    """
+    .. todo::
+        This function is not yet implemented
+    
+    Convert Apache Parquet MS to FITS format (future)
+
+    Parameters
+    ----------
+    infile : str
+        Input Parquet filename
+    outfile : str
+        Output FITS filename. If None, will use infile name with .fits extension
+
+    Returns
+    -------
+    bool
+        Success status
+    """
+    return True
+

conversion/pq_to_ms.py

@@ -0,0 +1,21 @@
+def pq_to_ms(infile, outfile=None):
+    """
+    .. todo::
+        This function is not yet implemented
+    
+    Convert Apache Parquet MS to Legacy CASA MS format
+
+    Parameters
+    ----------
+    infile : str
+        Input Parquet filename
+    outfile : str
+        Output MS filename. If None, will use infile name with .ms extension
+
+    Returns
+    -------
+    bool
+        Success status
+    """
+    return True
+

docs/conf.py

@@ -40,11 +40,16 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx.ext.todo',
+    'sphinx.ext.viewcode',
     'sphinx.ext.coverage',
     'sphinx.ext.githubpages',
     'sphinx.ext.napoleon'
 ]
 
+todo_include_todos = True
+add_module_names = False
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']