DOC: Cleaned up commits, updated index.rst and build docs.

continuous_integration/build_docs.sh

@@ -3,20 +3,21 @@
 # https://github.com/pydata/pandas
 set -e
 
-cd "$TRAVIS_BUILD_DIR"
-
 echo "Building Docs"
-conda install -q sphinx pillow
+conda install -q sphinx pillow ipython
+conda install numpydoc
+pip install sphinx_rtd_theme
+pip install sphinx_gallery
+pip install sphinx-copybutton
 
-mv "$TRAVIS_BUILD_DIR"/doc /tmp
-cd /tmp/doc
-mv -f source/index.ci source/index.rst
+cd doc
+make clean
 make html
 
 # upload to pyart-docs-travis repo is this is not a pull request and
 # secure token is available (aka in the ARM-DOE repository.
 if [ "$TRAVIS_PULL_REQUEST" == "false" ] && [ $TRAVIS_SECURE_ENV_VARS == 'true' ]; then
-    cd /tmp/doc/build/html
+    cd build/html
     git config --global user.email "[email protected]"
     git config --global user.name "pyart-docs-bot"
 

doc/source/conf.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 #
-# Atmospheric data Community Toolkit documentation build configuration file, created by
+# Python ARM Radar Toolkit documentation build configuration file, created by
 # sphinx-quickstart on Thu Jun 28 12:35:56 2018.
 #
 # This file is execfile()d with the current directory set to its
@@ -46,14 +46,17 @@
     'matplotlib.sphinxext.plot_directive',
     'numpydoc',
     'sphinx_copybutton',
-    'sphinx_gallery.gen_gallery',
 ]
 
-sphinx_gallery_conf = {
-    'examples_dirs': '../../examples',
-    'gallery_dirs': 'source/auto_examples'
+# only include examples if the BUILD_PYART_EXAMPLES env. variable is set
+if 'BUILD_PYART_EXAMPLES' in os.environ:
+    extensions.append('sphinx_gallery.gen_gallery')
+    sphinx_gallery_conf = {
+        'examples_dirs': '../../examples',
+        'gallery_dirs': 'source/auto_examples'
 }
 
+
 # Configuration options for plot_directive. See:
 # https://github.com/matplotlib/matplotlib/blob/f3ed922d935751e08494e5fb5311d3050a3b637b/lib/matplotlib/sphinxext/plot_directive.py#L81
 plot_html_show_source_link = False
@@ -195,15 +198,12 @@
      [author], 1)
 ]
 
-
 # -- Options for Texinfo output -------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 
-
-
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3/', None),

doc/source/index.rst

@@ -2,11 +2,9 @@
 The Python ARM Radar Toolkit - Py-ART
 =====================================
 
-Latest Release
-==============
-
 .. toctree::
-    :maxdepth: 4
+    :maxdepth: 1
+    :hidden:
 
     user_reference/index
     dev_reference/index
@@ -16,6 +14,12 @@ Latest Release
     setting_up_an_environment.rst
     contributors_guide.rst
 
+    Anaconda Cloud <https://anaconda.org/conda-forge/arm_pyart>
+    GitHub Repo <https://github.com/ARM-DOE/pyart>
+
+    Mailing List <https://groups.google.com/forum/#!forum/pyart-users>
+    Science Lead (Scott Collis) <https://www.anl.gov/profile/scott-m-collis>
+
 
 
 What is Py-ART?
@@ -75,6 +79,17 @@ A sophisticated mapping routines is able to efficiently create uniform
 Cartesian grids of radar fields from one or more radars. Routines exist in
 Py-ART for plotting these grids as well as saving them to NetCDF files.
 
+Short Courses
+=============
+
+Various short courses on Py-ART and open source radar software have been given
+which contain tutorial like materials and additional examples.
+
+* `2015 AMS, Open Source Radar Short Course <https://github.com/openradar/AMS-Short-Course-on-Open-Source-Radar-Software>`_
+* `2015 ARM/ASR Meeting, PyART, the Python ARM Radar Toolkit  <https://github.com/ARM-DOE/notebooks/tree/master/ASR_PI_2015>`_
+* `2014 ARM/ASM Meeting, Py-ART tutorial <https://github.com/ARM-DOE/notebooks/tree/master/ASR_PI_2014>`_
+* `2014 ERAD, Open Source Radar Short Course <https://github.com/openradar/open_source_radar_short_course>`_
+
 Install
 =======