Skip to content

Commit

Permalink
Fix links in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
astrofrog committed Feb 17, 2019
1 parent a4a81ca commit 435f55e
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 23 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The following dependencies are required:
- `Numpy <http://www.numpy.org>`__ 1.11 or later
- `Matplotlib <http://www.matplotlib.org>`__ 2.0 or later
- `Astropy <http://www.astropy.org>`__ 3.1 or later
- `reproject <http://reproject.readthedocs.org>`__ 0.4 or later
- `reproject <https://reproject.readthedocs.org>`__ 0.4 or later

and the following are optional:

Expand Down
20 changes: 8 additions & 12 deletions aplpy/_astropy_init.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,7 @@ def test(package=None, test_path=None, args=None, plugins=None,
verbose=False, pastebin=None, remote_data=False, pep8=False,
pdb=False, coverage=False, open_files=False, **kwargs):
"""
Run the tests using `py.test <http://pytest.org/latest>`__. A proper set
of arguments is constructed and passed to `pytest.main`_.
.. _py.test: http://pytest.org/latest/
.. _pytest.main: http://pytest.org/latest/builtin.html#pytest.main
Run the tests using `py.test <https://docs.pytest.org/en/latest/>`__.
Parameters
----------
Expand All @@ -52,19 +48,19 @@ def test(package=None, test_path=None, args=None, plugins=None,
calling directory.
args : str, optional
Additional arguments to be passed to pytest.main_ in the ``args``
Additional arguments to be passed to pytest.main in the ``args``
keyword argument.
plugins : list, optional
Plugins to be passed to pytest.main_ in the ``plugins`` keyword
Plugins to be passed to pytest.main in the ``plugins`` keyword
argument.
verbose : bool, optional
Convenience option to turn on verbose output from py.test_. Passing
Convenience option to turn on verbose output from py.test. Passing
True is the same as specifying ``'-v'`` in ``args``.
pastebin : {'failed','all',None}, optional
Convenience option for turning on py.test_ pastebin output. Set to
Convenience option for turning on py.test pastebin output. Set to
``'failed'`` to upload info for failed tests, or ``'all'`` to upload
info for all tests.
Expand All @@ -75,7 +71,7 @@ def test(package=None, test_path=None, args=None, plugins=None,
pep8 : bool, optional
Turn on PEP8 checking via the `pytest-pep8 plugin
<http://pypi.python.org/pypi/pytest-pep8>`_ and disable normal
<https://pypi.org/project/pytest-pep8/>`_ and disable normal
tests. Same as specifying ``'--pep8 -k pep8'`` in ``args``.
pdb : bool, optional
Expand All @@ -89,13 +85,13 @@ def test(package=None, test_path=None, args=None, plugins=None,
open_files : bool, optional
Fail when any tests leave files open. Off by default, because
this adds extra run time to the test suite. Requires the
`psutil <https://pypi.python.org/pypi/psutil>`_ package.
`psutil <https://pypi.org/project/psutil/>`_ package.
parallel : int, optional
When provided, run the tests in parallel on the specified
number of CPUs. If parallel is negative, it will use the all
the cores on the machine. Requires the
`pytest-xdist <https://pypi.python.org/pypi/pytest-xdist>`_ plugin
`pytest-xdist <https://pypi.org/project/pytest-xdist/>`_ plugin
installed. Only available when using Astropy 0.3 or later.
kwargs
Expand Down
3 changes: 1 addition & 2 deletions aplpy/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,7 @@ class FITSFigure(Layers, Regions):
figsize=(xsize, ysize) argument (where xsize and ysize are in
inches). For more information on these additional arguments, see
the *Optional keyword arguments* section in the documentation for
`Figure
<http://matplotlib.org/api/figure_api.html?#matplotlib.figure.Figure>`_
:class:`~matplotlib.figure.Figure`.
"""

@auto_refresh
Expand Down
2 changes: 1 addition & 1 deletion aplpy/rgb.py
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ def make_rgb_cube(files, output, north=False, system=None, equinox=None):
This method can read in three FITS files with different
projections/sizes/resolutions and uses the `reproject
<http://reproject.readthedocs.io/en/stable/>`_ package to reproject them all
<https://reproject.readthedocs.io/en/stable/>`_ package to reproject them all
to the same projection.
Two files are produced by this function. The first is a three-dimensional
Expand Down
6 changes: 3 additions & 3 deletions docs/fitsfigure/arbitrary_coordinate_systems.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ the :meth:`~aplpy.FITSFigure.set_xaxis_coord_type` and :meth:`~aplpy.FITSFigure.
f = FITSFigure('2MASS_k.fits')
f.set_xaxis_coord_type('scalar')
f.set_xaxis_coord_type('latitude')

Valid coordinate types are ``longitude``, ``latitude``, and ``scalar``.
Longitudes are forced to be in the 0 to 360 degree range, latitudes are forced
to be in the -90 to 90 degree range, and scalars are not constrained.
Expand Down Expand Up @@ -46,7 +46,7 @@ If the coordinate type is scalar, then the format should be specified as a
valid Python format. For example, ``%g`` is the default Python format,
``%10.3f`` means decimal notation with three decimal places, etc. For more
information, see `String Formatting Operations
<http://docs.python.org/library/stdtypes.html#string-formatting>`_.
<https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting>`_.

In both cases, the default label format can be overridden::

Expand All @@ -60,4 +60,4 @@ When plotting images in sky coordinates, APLpy makes pixel square by default,
but it is possible to change this, which can be useful for non-sky
coordinates. When calling :meth:`~aplpy.FITSFigure.show_grayscale` or
:meth:`~aplpy.FITSFigure.show_colorscale`, simply add ``aspect='auto'``
which will override the ``aspect='equal'`` default.
which will override the ``aspect='equal'`` default.
2 changes: 1 addition & 1 deletion docs/fitsfigure/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Beginner Tutorial
:maxdepth: 1

The following tutorial will take you, step by step, through the main features
of APLpy. You will need to download the following `file <http://aplpy.github.com/downloads/tutorial.tar.gz>`_.
of APLpy. You will need to download the following `file <http://aplpy.github.io/downloads/tutorial.tar.gz>`_.

First, unpack the example files and go to the ``tutorial`` directory::

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ since 2009.
Since APLpy 2.0, APLpy relies on Astropy's `WCSAxes
<http://docs.astropy.org/en/stable/visualization/wcsaxes/index.html>`_ package
to draw the coordinate axes and grids, which in turn uses `Matplotlib
<http://matplotlib.org>`_ to do the rendering. This is a big change compared to
<https://matplotlib.org>`_ to do the rendering. This is a big change compared to
previous versions of APLpy, which handled the drawing of the coordinate axes and
grids directly. For information about backward-compatibility, see the
`Backward-compatibility notes`_.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
APLpy documentation
===================

This is the documentation for APLpy. The APLpy homepage is located at http://aplpy.github.com
This is the documentation for APLpy. The APLpy homepage is located at http://aplpy.github.io

.. toctree::
:maxdepth: 1
Expand Down
2 changes: 1 addition & 1 deletion docs/rgb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ following code shows how this can be done using the
'2mass_j.fits'], '2mass_cube.fits')

This method makes use of the `reproject
<http://reproject.readthedocs.io/en/stable/>`_ package to reproject the images
<https://reproject.readthedocs.io/en/stable/>`_ package to reproject the images
to a common projection. The above example produces a FITS cube named
``2mass_cube.fits`` which contains the three channels in the same projection.
This can be used to then produce an RGB image (see next section)
Expand Down

0 comments on commit 435f55e

Please sign in to comment.