Merge pull request #678 from astrofrog/link-checker

Add link checker for docs

.travis.yml

@@ -114,7 +114,7 @@ install:
   # For now we also install astropy_helpers because setup_requires has a bug
   # that means it generates PEP440 warnings for the astropy_helpers version
   # number.
-  - if [ $DOC_TRIGGER ]; then pip install astropy-helpers; fi
+  - if [ $DOC_TRIGGER ]; then pip install astropy-helpers linkchecker; fi
 
   - python setup.py install
 
@@ -124,8 +124,11 @@ script:
 
   # In the following command, the test -s ensures that warnings are not emitted
   # by the docs build.
-  - if [ $DOC_TRIGGER ]; then cat doc/warnings.log; fi
-  - if [ $DOC_TRIGGER ]; then test ! -s doc/warnings.log; fi
+  - if [ $DOC_TRIGGER ]; then
+      cat doc/warnings.log;
+      test ! -s doc/warnings.log;
+      linkchecker --ignore-url=".*fontawesome_webfont.*" doc/_build/html;
+    fi
 
 after_success:
 

doc/faq.rst

@@ -23,7 +23,7 @@ Glue relies on several libraries to parse different file formats:
    tables.
  * `scikit-image <http://scikit-image.org/>`_ to read popular image
    formats like ``.jpeg`` and ``.tiff``
- * `h5py <http://www.h5py.org/docs/>`_ to read HDF5 files
+ * `h5py <http://www.h5py.org/>`_ to read HDF5 files
 
 If Glue's predefined data loaders don't fit your needs, ou can also :ref:`write your own <custom_data_factory>` loader, and plug it into Glue.
 

doc/getting_started/index.rst

@@ -2,7 +2,7 @@
 
 Getting started
 ***************
-This page walks through Glue's basic GUI features, using data from the W5 star forming region as an example. You can download the data files for this tutorial `here <_static/w5.tgz>`_
+This page walks through Glue's basic GUI features, using data from the W5 star forming region as an example. You can download the data files for this tutorial :download:`here <w5.tgz>`
 
 After :ref:`installing <installation>` Glue, open the program by either double clicking on the icon (if using a pre-built application) or from the command line::
 

doc/installation.rst

@@ -62,7 +62,7 @@ these packages is somewhat beyond the scope of this document, and
 unforunately trickier than it should be. If you want to dive in, here
 is the basic strategy:
 
- * Install `Qt 4 <http://qt-project.org/downloads>`_ and either `PyQt4 <http://www.riverbankcomputing.com/software/pyqt/download>`_ or `PySide <http://qt-project.org/wiki/Get-PySide>`_. If at all possible, use the binary installers; building PyQt4 or PySide from source is tricky (this is a euphemism).
+ * Install `Qt 4 <http://download.qt.io/archive/qt/4.8/4.8.6/>`_ and either `PyQt4 <http://www.riverbankcomputing.com/software/pyqt/download>`_ or `PySide <http://qt-project.org/wiki/Get-PySide>`_. If at all possible, use the binary installers; building PyQt4 or PySide from source is tricky (this is a euphemism).
 
  * Install Glue using pip: ``pip install glueviz``. Alternatively, ``git clone`` the repository and install via ``python setup.py install``
 

doc/python_guide/custom_viewer.rst

@@ -119,7 +119,7 @@ set up this functionality. Keywords serve two purposes: they define
 new widgets to interact with the viewer, and they define keywords to pass
 onto drawing functions like ``plot_data``.
 
-For example, consider `this version <scripts/bball_viewer_3.py>`__ of the Shot Plot code:
+For example, consider :download:`this version <scripts/bball_viewer_3.py>` of the Shot Plot code:
 
 .. literalinclude:: scripts/bball_viewer_3.py
    :linenos:
@@ -167,7 +167,7 @@ contained in a user-drawn :class:`region of interest <glue.core.roi.Roi>`:
    :lines: 18-20
    :linenos:
 
-With `this version <scripts/bball_viewer_4.py>`__ of the code you can how draw shapes on the plot to select data:
+With :download:`this version <scripts/bball_viewer_4.py>` of the code you can how draw shapes on the plot to select data:
 
 .. figure:: images/bball_5.png
    :align: center