Merge pull request #22 from andersy005/master

Update documentation
NCAR · Dec 21, 2018 · b8c2cef · b8c2cef
2 parents 148f441 + 300987b
commit b8c2cef
Show file tree

Hide file tree

Showing 9 changed files with 50 additions and 128 deletions.
diff --git a/ci/install-circleci.sh b/ci/install-circleci.sh
diff --git a/ci/upload-anaconda.sh b/ci/upload-anaconda.sh
@@ -11,7 +11,7 @@ export UPLOADFILE=`conda build conda/ --output`
 echo "UPLOADFILE = ${UPLOADFILE}"
 
 echo "[Uploading esmalb]"
-# anaconda -t ${CONDA_UPLOAD_TOKEN} upload -u cisl-iowa --force ${UPLOADFILE}
+anaconda -t ${CONDA_UPLOAD_TOKEN} upload -u cisl-iowa --force ${UPLOADFILE}
 echo "Successfully deployed to Anaconda.org."
 
 exit 0
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -1,6 +1,5 @@
-API
-===
-
+API reference
+=============
 
 
 Statistics functions

diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -1,2 +1,2 @@
 Changelog
-=========
+=========
diff --git a/docs/source/develop.rst b/docs/source/develop.rst
@@ -0,0 +1,34 @@
+.. highlight:: shell
+
+Development Guide
+======================
+
+Some general guidelines regarding development in esmlab for maintainers
+and contributors. Nothing here is set in stone and can't be changed.
+Feel free to suggest improvements or changes in the workflow.
+
+Code Style
+-----------
+
+For style we use black, isort, and flake8. These are available as pre-commit
+hooks that will run every time you are about to commit code.
+
+From the root directory of `esmlab` project run the following:
+
+.. code-block:: console
+
+    $ pip install pre-commit
+    $ pre-commit install
+
+
+Branches (TODO)
+----------------
+
+
+
+Issues (TODO)
+-------------
+
+
+Release procedure (TODO)
+------------------------
diff --git a/docs/source/history.rst b/docs/source/history.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -5,13 +5,13 @@
    :caption: Contents:
 
    installation
-   usage
    api
+   develop
    changelog
-   history
+
 
 Indices and tables
 ==================
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
+* :ref:`search`
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -5,22 +5,22 @@ Installation
 ============
 
 
-Stable release (COMING SOON!)
---------------------------------
+Conda
+-------
 
 To install esmlab, run this command in your terminal:
 
 .. code-block:: console
 
-    $ pip install esmlab
+    $ conda install -c cisl-iowa esmlab
 
-This is the preferred method to install esmlab, as it will always install the most recent stable release.
+This is the preferred method to install esmlab, as it will always install
+the most recent stable release.
 
-If you don't have `pip`_ installed, this `Python installation guide`_ can guide
-you through the process.
+Pip
+----
 
-.. _pip: https://pip.pypa.io
-.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
+Support is coming soon, please use conda for the time being.
 
 
 From sources
@@ -54,4 +54,4 @@ Once you have a copy of the source, you can install it with:
 
 
 .. _Github repo: https://github.com/NCAR/esmlab
-.. _tarball: https://github.com/NCAR/esmlab/tarball/master
+.. _tarball: https://github.com/NCAR/esmlab/tarball/master
diff --git a/docs/source/usage.rst b/docs/source/usage.rst