Testing out the documents

MAVENSDC · Feb 9, 2022 · 3112b7c · 3112b7c
1 parent 36d0a9e
commit 3112b7c
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 3 deletions.
diff --git a/doc/introduction.rst b/doc/introduction.rst
@@ -4,7 +4,9 @@ Introduction
 What is cdflib?
 ------------------
 
-cdflib is an effort to replicate the CDF libraries using a pure python implementation.  This means users do not need to install the CDF libraries.  
+cdflib is an effort to replicate the CDF libraries using a pure python implementation.  This means users do not need to install the `CDF NASA libraries <https://cdf.gsfc.nasa.gov/>`_.  
+
+The only module you need to install is numpy, but there are a few things you can do with astropy and xarray.  
 
 While this origally started as a way to read PDS-archive compliant CDF files, thanks to many contributors, it has grown to be able to handle every type of CDF file.  
 
@@ -13,7 +15,7 @@ What does it do?
 -------------------
 
 * Ability to read variables and attributes from CDF files
-* Can write CDF files
-* Can convert between CDF time types and other common time formats
+* Writes CDF version 3 files
+* Can convert between CDF time types (EPOCH/EPOCH16/TT2000) to other common time formats
 * Can convert CDF files into XArray Dataset objects
 * Can convert XArray Dataset objects into CDF files, attempting to maintain ISTP compliance 
diff --git a/doc/modules/cdf_to_xarray.rst b/doc/modules/cdf_to_xarray.rst
@@ -0,0 +1,11 @@
+cdf_to_xarray
+=============
+
+cdf_to_xarray function
+-----------------------
+
+This module is comprised of a single function which takes a CDF file and converts it to an XArray Dataset object.    
+
+This will attempt to determine any `ISTP Complaince <https://spdf.gsfc.nasa.gov/istp_guide/istp_guide.html>`_ within the file, and incorporate that into the Dataset object.   
+
+.. autofunction:: pytplot.cdf_to_xarray
diff --git a/doc/modules/xarray_to_cdf.rst b/doc/modules/xarray_to_cdf.rst
@@ -0,0 +1,11 @@
+xarray_to_cdf
+=============
+
+xarray_to_cdf function
+-----------------------
+
+This module is comprised of a single function which takes XArray Dataset files and converts them into CDF files.  
+
+This will attempt to conform to `ISTP Complaince <https://spdf.gsfc.nasa.gov/istp_guide/istp_guide.html>`_, and optionally provide warnings if it is not compliant.  
+
+.. autofunction:: pytplot.xarray_to_cdf