Merge pull request #2426 from astrofrog/update-standalone-docs

Update standalone application instructions

.readthedocs.yml

@@ -3,6 +3,11 @@ version: 2
 build:
   image: latest
 
+sphinx:
+  builder: html
+  configuration: doc/conf.py
+  fail_on_warning: true
+
 python:
   version: 3.8
   install:

doc/installation/standalone.rst

@@ -6,10 +6,9 @@ Standalone MacOS X and Windows applications
 On MacOS X and Windows, the easiest way to install glue along with a few of
 the common glue plugins is to download pre-built single-file applications.
 
-.. note:: This installation method is very recent, so if you run into any issues
+.. note:: If you run into any issues
           it would be really helpful if you could let us know by `opening an issue
-          <https://github.com/glue-viz/glue-standalone-apps/issues/new>`_. In the
-          mean time, you can always try one of the other installation methods.
+          <https://github.com/glue-viz/glue-standalone-apps/issues/new>`_.
 
 The plugins included by default in the standalone applications are:
 
@@ -25,39 +24,20 @@ should check one of the other installation methods mentioned in
 MacOS X
 -------
 
-Donwload the :download:`glue 2023.02.0.dmg
-<https://glueviz.s3.amazonaws.com/installers/2023.02.0/glue%202023.02.0.dmg>`
-file, open it and copy the **glue 2023.02.0.app** application to your
-**Applications** folder (or any other location you want to use).
-
-Open the copied application - after a short wait, you will likely see a dialog that looks like:
-
-.. image:: images/warning1_osx.png
-   :align: center
-   :width: 300
-
-Click **OK** then go to the MacOS X **Settings**, then **Security and Privacy**, then go to the
-**General** tab. You will likely see the following message:
-
-.. image:: images/warning2_osx.png
-   :align: center
-   :width: 600
-
-Click on **Open anyway**, then in the following dialog:
-
-.. image:: images/warning3_osx.png
-   :align: center
-   :width: 300
-
-Click **Open**. The glue application should now open! You should only need to do all this when
-installing a new version, if you relaunch the same application it should now work straight away.
+Donwload the :download:`glue 2023.06.4.dmg
+<https://glueviz.s3.amazonaws.com/installers/2023.06.4/glue%202023.06.4.dmg>`
+file, open it and copy the **glue 2023.06.4.app** application to your
+**Applications** folder (or any other location you want to use). You will
+likely see a dialog asking you whether to continue opening the application as it
+was downloaded from the internet - if so, you can proceed (this is a standard
+warning for any application not installed via the Mac App Store).
 
 Windows
 -------
 
-Donwload the :download:`glue 2023.02.0.exe
-<https://glueviz.s3.amazonaws.com/installers/2023.02.0/glue%202023.02.0.exe>` file.
-Once the file has downloaded, open the **glue 2023.02.0.exe** application. You
+Donwload the :download:`glue 2023.06.4.exe
+<https://glueviz.s3.amazonaws.com/installers/2023.06.4/glue%202023.06.4.exe>` file.
+Once the file has downloaded, open the **glue 2023.06.4.exe** application. You
 will likely then see a dialog such as:
 
 .. image:: images/warning1_windows.png
@@ -81,6 +61,5 @@ and are checked to make sure they all work correctly. We also provide
 glue packages and plugins. These are generated automatically and are
 not hand-checked, so may be unstable. The download links are:
 
-* Linux: :download:`glue-nightly <https://glueviz.s3.amazonaws.com/installers/nightly/glue-nightly>`
-* MacOS X: :download:`glue nightly.dmg <https://glueviz.s3.amazonaws.com/installers/nightly/glue%20nightly.dmg>`
-* Windows: :download:`glue nightly.exe <https://glueviz.s3.amazonaws.com/installers/nightly/glue%20nightly.exe>`
+* MacOS X: :download:`glue main.dmg <https://glueviz.s3.amazonaws.com/installers/main/glue%20main.dmg>`
+* Windows: :download:`glue main.exe <https://glueviz.s3.amazonaws.com/installers/main/glue%20main.exe>`

glue/app/qt/tests/test_application.py

@@ -311,7 +311,7 @@ def check_clone_app(app):
     for tab1, tab2 in zip(app.viewers, copy.viewers):
         assert len(tab1) == len(tab2)
         for v1, v2 in zip(tab1, tab2):
-            assert type(v1) == type(v2)
+            assert type(v1) is type(v2)
             # same window properties
             assert v1.viewer_size == v2.viewer_size
             assert v1.position == v2.position

glue/core/data_derived.py

@@ -73,7 +73,7 @@ def indices(self, value):
             changed = False
             for idim in range(self._original_data.ndim):
                 before, after = self._indices[idim], value[idim]
-                if type(before) != type(after):
+                if type(before) is not type(after):
                     raise TypeError("Can't change where the ``None`` values are in indices")
                 elif before != after:
                     changed = True

glue/core/data_factories/helpers.py

@@ -147,7 +147,7 @@ def reload(self):
             mapping = dict((c, log.component(self.id(c)).data)
                            for c in dold._components.values()
                            if c in self.components and
-                           type(c) == Component)
+                           type(c) is Component)
             dold.coords = dnew.coords
             dold.update_components(mapping)
 

glue/core/layer_artist.py

@@ -265,7 +265,7 @@ def on_changed(self, func):
 
     def _duplicate(self, artist):
         for a in self.artists:
-            if type(a) == type(artist) and a.layer is artist.layer:
+            if type(a) is type(artist) and a.layer is artist.layer:
                 return True
         return False
 

glue/core/qt/data_collection_model.py

@@ -179,7 +179,7 @@ def label(self, value):
 
     @property
     def tooltip(self):
-        if type(self.subset_group.subset_state) == core.subset.SubsetState:
+        if type(self.subset_group.subset_state) is core.subset.SubsetState:
             return "Empty subset"
 
         atts = self.subset_group.subset_state.attributes

glue/core/tests/test_coordinates.py

@@ -170,31 +170,31 @@ class TestCoordinatesFromHeader(object):
     def test_2d_nowcs(self):
         hdr = {"NAXIS": 2}
         coord = coordinates_from_header(hdr)
-        assert type(coord) == IdentityCoordinates
+        assert type(coord) is IdentityCoordinates
         assert coord.pixel_n_dim == 2
         assert coord.world_n_dim == 2
 
     def test_2d(self):
         hdr = header_from_string(HDR_2D_VALID)
         coord = coordinates_from_header(hdr)
-        assert type(coord) == WCSCoordinates
+        assert type(coord) is WCSCoordinates
 
     def test_3d_nowcs(self):
         hdr = HDR_3D_VALID_NOWCS
         coord = coordinates_from_header(header_from_string(hdr))
-        assert type(coord) == IdentityCoordinates
+        assert type(coord) is IdentityCoordinates
         assert coord.pixel_n_dim == 3
         assert coord.world_n_dim == 3
 
     def test_3d(self):
         hdr = header_from_string(HDR_3D_VALID_WCS)
         coord = coordinates_from_header(hdr)
-        assert type(coord) == WCSCoordinates
+        assert type(coord) is WCSCoordinates
 
     def test_nod(self):
         hdr = 0
         coord = coordinates_from_header(hdr)
-        assert type(coord) == IdentityCoordinates
+        assert type(coord) is IdentityCoordinates
 
 
 HDR_2D_VALID = """

glue/core/tests/test_link_manager.py

@@ -36,10 +36,10 @@ def example_components(self, add_derived=True):
 
     dummy_using = lambda x, y: (x, y)
     self.cs = [c1, c2, c3, c4, c5, c6, c7, c8]
-    self.links = [ComponentLink([c1], c3, lambda x:x),
-                  ComponentLink([c2], c4, lambda x:x),
-                  ComponentLink([c3], c1, lambda x:x),
-                  ComponentLink([c4], c2, lambda x:x),
+    self.links = [ComponentLink([c1], c3, lambda x: x),
+                  ComponentLink([c2], c4, lambda x: x),
+                  ComponentLink([c3], c1, lambda x: x),
+                  ComponentLink([c4], c2, lambda x: x),
                   ComponentLink([c3, c4], c5, dummy_using),
                   ComponentLink([c3, c4], c6, dummy_using)]
 

glue/core/tests/test_subset.py

@@ -440,7 +440,7 @@ def assert_composite_copy(self, cls):
         s1 = cls(state1, state2)
         s2 = s1.copy()
 
-        assert type(s1) == type(s2)
+        assert type(s1) is type(s2)
         assert s1.state1.copy() is s2.state1
         assert s1.state2.copy() is s2.state2
 

glue/viewers/image/qt/slice_widget.py

@@ -88,7 +88,7 @@ def sync_sliders_from_state(self, *args):
                 # but we will need to generalize this in future. We deliberately
                 # check the type of data.coords here since we want to treat
                 # subclasses differently.
-                if getattr(self.data, 'coords') is not None and type(self.data.coords) != LegacyCoordinates:
+                if getattr(self.data, 'coords') is not None and type(self.data.coords) is not LegacyCoordinates:
                     world_axis_index = self.data.ndim - 1 - i
                     world = world_axis(self.data.coords, self.data,
                                        pixel_axis=world_axis_index,

glue/viewers/image/viewer.py

@@ -127,7 +127,7 @@ def _set_wcs(self, before=None, after=None, relim=True):
             self.state.reset_limits()
 
         # Determine whether changing slices requires changing the WCS
-        if ref_coords is None or type(ref_coords) == Coordinates:
+        if ref_coords is None or type(ref_coords) is Coordinates:
             self._changing_slice_requires_wcs_update = False
         else:
             ix = self.state.x_att.axis

setup.cfg

@@ -81,7 +81,7 @@ all =
     # for why we exclude pillow 7.1.0
     pillow!=7.1.0
 docs =
-    sphinx
+    sphinx<7
     sphinx-automodapi
     sphinxcontrib-spelling
     numpydoc