Merge pull request #11 from aburrell/documentation

documentation updates
aburrell · Mar 21, 2018 · aaf257f · aaf257f
2 parents 391d80f + 3f9ce1f
commit aaf257f
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 11 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -2,12 +2,18 @@
 Changelog
 =========
 
-2.0.1 (2017-03-09)
+2.4.0 (2017-03-21)
 -----------------------------------------
 
 * Update to use AACGM-v2.4, which includes changes to the inverse MLT and
   dipole tilt functions and some minor bug fixes
-
+* Updated file structure
+* Updated methods, retaining old methods in deprecated module
+* Added testing for python 3.6
+* Updated dependencies, removing support for python 3.3
+* Tested on Mac OSX
+* Updated comments to include units for input and output
+
 2.0.0 (2016-11-03)
 -----------------------------------------
 

diff --git a/README.rst b/README.rst
@@ -49,6 +49,7 @@ Documentation
 =============
 
 https://aacgmv2.readthedocs.org/
+
 http://superdarn.thayer.dartmouth.edu/aacgm.html
 
 Badges

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -2,16 +2,22 @@
 Installation
 ============
 
-This package requires NumPy, which you can install alone or as a part of SciPy. `Some Python distributions <http://www.scipy.org/install.html#scientific-python-distributions>`_ come with NumPy/SciPy pre-installed. For Python distributions without NumPy/SciPy, Windows/Mac users should install `pre-compiled binaries of NumPy/SciPy <http://www.scipy.org/scipylib/download.html#official-source-and-binary-releases>`_, and Linux users may have NumPy/SciPy available in `their repositories <http://www.scipy.org/scipylib/download.html#third-party-vendor-package-managers>`_.
+This package requires NumPy, which you can install alone or as a part of SciPy.
+`Some Python distributions <http://www.scipy.org/install.html#scientific-python-distributions>`_ come with NumPy/SciPy pre-installed. For Python distributions
+without NumPy/SciPy, Windows/Mac users should install
+`pre-compiled binaries of NumPy/SciPy <http://www.scipy.org/scipylib/download.html#official-source-and-binary-releases>`_, and Linux users may have NumPy/SciPy
+available in `their repositories <http://www.scipy.org/scipylib/download.html#third-party-vendor-package-managers>`_.
 
-When you have NumPy, install this package at the command line using ``pip`` [1]_::
+When you have NumPy, install this package at the command line using
+``pip`` [1]_::
 
     pip install aacgmv2
 
 The package has been tested with the following setups (others might work, too):
 
 * Mac (64 bit), Windows (32/64 bit), and Linux (64 bit)
-* Python 2.7, 3.3, 3.4, 3.5, and 3.6
-* NumPy 1.8, 1.9, 1.10, 1.14.1
+* Python 2.7, 3.4, 3.5, and 3.6
 
-.. [1] pip is included with Python 2 from v2.7.9 and Python 3 from v3.4. If you don't have pip, `get it here <http://pip.readthedocs.org/en/stable/installing/>`_.
+.. [1] pip is included with Python 2 from v2.7.9 and Python 3 from v3.4. If you
+       don't have pip,
+       `get it here <http://pip.readthedocs.org/en/stable/installing/>`_.
diff --git a/docs/reference/_aacgmv2.rst b/docs/reference/_aacgmv2.rst
@@ -1,7 +1,7 @@
 aacgmv2._aacgmv2
 ================
 
-This submodule contains the interface to the AACGM-v2 C library. For the user-friendly wrapper, see :func:`aacgmv2.convert`.
+This submodule contains the interface to the AACGM-v2 C library. For the user-friendly wrapper, see the functions in :py:module:`aacgmv2.wrapper`.
 
 .. automodule:: aacgmv2._aacgmv2
     :members:
diff --git a/docs/reference/aacgmv2.rst b/docs/reference/aacgmv2.rst
@@ -5,3 +5,10 @@ These functions are available when you ``import aacgmv2``.
 
 .. automodule:: aacgmv2
     :members:
+
+.. automodule:: aacgmv2.wrapper
+    :members:
+
+.. automodule:: aacgmv2.deprecated
+    :members:
+
diff --git a/docs/reference/cli.rst b/docs/reference/cli.rst
@@ -3,9 +3,14 @@ Command-line interface
 
 .. highlight:: none
 
-When you install this package you will get a command called ``aacgmv2``. It has two subcommands, ``convert`` and ``convert_mlt``, which correspond to the functions :py:func:`aacgmv2.convert` and :py:func:`aacgmv2.convert_mlt`. See the documentation for these functions for a more thorough explanation of arguments and behaviour.
-
-You can get help on the two commands by running ``aacgmv2 convert -h`` and ``aacgmv2 convert_mlt -h``.
+When you install this package you will get a command called ``aacgmv2``. It has
+two subcommands, ``convert`` and ``convert_mlt``, which correspond to the
+functions :py:func:`aacgmv2.convert_latlon_arr` and
+:py:func:`aacgmv2.convert_mlt`. See the documentation for these functions for a
+more thorough explanation of arguments and behaviour.
+
+You can get help on the two commands by running ``aacgmv2 convert -h`` and
+``aacgmv2 convert_mlt -h``.
 
 convert
 -------