MAINT: adding linkcheck to CI and minor fixes (#377)

* CI: adding linkcheck job to CI and cleaning up envs in tox config * MAINT: fixing links and redirects
astropy · Oct 24, 2022 · a7f247f · a7f247f
1 parent a7f41c1
commit a7f247f
Show file tree

Hide file tree

Showing 18 changed files with 25 additions and 30 deletions.
diff --git a/.github/workflows/cibuild.yml b/.github/workflows/cibuild.yml
@@ -26,6 +26,9 @@ jobs:
           - name: py310 with online tests, Linux
             python-version: '3.10'
             tox_env: py310-test-alldeps-online
+          - name: linkcheck
+            python-version: '3.10'
+            tox_env: linkcheck
 
     steps:
     - name: Checkout code

diff --git a/README.rst b/README.rst
@@ -2,7 +2,7 @@ PyVO
 ===================================
 
 .. image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
-    :target: http://www.astropy.org
+    :target: https://www.astropy.org
     :alt: Powered by Astropy Badge
 
 .. image:: https://github.com/astropy/pyvo/workflows/CI/badge.svg?branch=main

diff --git a/docs/index.rst b/docs/index.rst
@@ -5,7 +5,7 @@ Introduction
 ------------
 
 This is the documentation for PyVO, an affiliated package for the
-`astropy <http://www.astropy.org>`__ package.
+`astropy <https://www.astropy.org>`__ package.
 
 PyVO lets you find and retrieve astronomical data available from archives that
 support standard `IVOA <http://www.ivoa.net/>`__ virtual observatory service
@@ -25,7 +25,7 @@ protocols.
 .. note::
   If you need to access data which is not available via the Virtual Observatory
   standards, try the astropy affiliated package
-  `astroquery <http://astroquery.readthedocs.io/en/latest/>`__ (and, of
+  `astroquery <https://astroquery.readthedocs.io/en/latest/>`__ (and, of
   course, ask the data providers to do the right thing and use the proper
   standards for their publication).
 

diff --git a/docs/registry/index.rst b/docs/registry/index.rst
@@ -27,6 +27,8 @@ There are two fundamental modes of searching in the VO:
 Both modes are supported by this module.
 
 
+.. _registry-basic-interface:
+
 Basic interface
 ===============
 
@@ -51,7 +53,7 @@ keyword arguments.  The following constraints are available:
   patterns; resources match when they serve columns having a matching
   UCD (e.g., ``phot.mag;em.ir.%`` for “any infrared magnitude”).
 * :py:class:`pyvo.registry.Waveband` (``waveband``): one or more terms
-  from the vocabulary at http://www.ivoa.net/messenger giving the rough
+  from the vocabulary at http://www.ivoa.net/rdf/messenger giving the rough
   spectral location of the resource.
 * :py:class:`pyvo.registry.Author` (``author``): an author (“creator”).
   This is a single SQL pattern, and given the sloppy practices in the

diff --git a/pyvo/dal/tests/data/query/basic.xml b/pyvo/dal/tests/data/query/basic.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- Produced with astropy.io.votable version 5.0.1
-     http://www.astropy.org/ -->
+     https://www.astropy.org/ -->
 <VOTABLE version="1.4" xmlns="http://www.ivoa.net/xml/VOTable/v1.3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.ivoa.net/xml/VOTable/v1.3 http://www.ivoa.net/xml/VOTable/VOTable-1.4.xsd">
  <RESOURCE type="results">
   <INFO ID="QUERY_STATUS" name="QUERY_STATUS" value="OK">OK</INFO>

diff --git a/pyvo/dal/tests/data/query/dataset.xml b/pyvo/dal/tests/data/query/dataset.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- Produced with astropy.io.votable version 5.0.1
-     http://www.astropy.org/ -->
+     https://www.astropy.org/ -->
 <VOTABLE version="1.4" xmlns="http://www.ivoa.net/xml/VOTable/v1.3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.ivoa.net/xml/VOTable/v1.3 http://www.ivoa.net/xml/VOTable/VOTable-1.4.xsd">
  <RESOURCE type="results">
   <INFO ID="QUERY_STATUS" name="QUERY_STATUS" value="OK">OK</INFO>

diff --git a/pyvo/dal/tests/data/query/errorstatus.xml b/pyvo/dal/tests/data/query/errorstatus.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- Produced with astropy.io.votable version 5.0.1
-     http://www.astropy.org/ -->
+     https://www.astropy.org/ -->
 <VOTABLE version="1.4" xmlns="http://www.ivoa.net/xml/VOTable/v1.3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.ivoa.net/xml/VOTable/v1.3 http://www.ivoa.net/xml/VOTable/VOTable-1.4.xsd">
  <RESOURCE type="results">
   <INFO ID="QUERY_STATUS" name="QUERY_STATUS" value="ERROR">ERROR</INFO>

diff --git a/pyvo/dal/tests/data/query/firstresource.xml b/pyvo/dal/tests/data/query/firstresource.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- Produced with astropy.io.votable version 5.0.1
-     http://www.astropy.org/ -->
+     https://www.astropy.org/ -->
 <VOTABLE version="1.4" xmlns="http://www.ivoa.net/xml/VOTable/v1.3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.ivoa.net/xml/VOTable/v1.3 http://www.ivoa.net/xml/VOTable/VOTable-1.4.xsd">
  <RESOURCE type="results">
   <INFO ID="QUERY_STATUS" name="QUERY_STATUS" value="OK">OK</INFO>

diff --git a/pyvo/dal/tests/data/query/missingcolumns.xml b/pyvo/dal/tests/data/query/missingcolumns.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- Produced with astropy.io.votable version 5.0.1
-     http://www.astropy.org/ -->
+     https://www.astropy.org/ -->
 <VOTABLE version="1.4" xmlns="http://www.ivoa.net/xml/VOTable/v1.3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.ivoa.net/xml/VOTable/v1.3 http://www.ivoa.net/xml/VOTable/VOTable-1.4.xsd">
  <RESOURCE type="results">
   <INFO ID="QUERY_STATUS" name="QUERY_STATUS" value="OK">OK</INFO>

diff --git a/pyvo/dal/tests/data/query/missingresource.xml b/pyvo/dal/tests/data/query/missingresource.xml
@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- Produced with astropy.io.votable version 5.0.1
-     http://www.astropy.org/ -->
+     https://www.astropy.org/ -->
 <VOTABLE version="1.4" xmlns="http://www.ivoa.net/xml/VOTable/v1.3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.ivoa.net/xml/VOTable/v1.3 http://www.ivoa.net/xml/VOTable/VOTable-1.4.xsd"/>
diff --git a/pyvo/dal/tests/data/query/missingtable.xml b/pyvo/dal/tests/data/query/missingtable.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- Produced with astropy.io.votable version 5.0.1
-     http://www.astropy.org/ -->
+     https://www.astropy.org/ -->
 <VOTABLE version="1.4" xmlns="http://www.ivoa.net/xml/VOTable/v1.3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.ivoa.net/xml/VOTable/v1.3 http://www.ivoa.net/xml/VOTable/VOTable-1.4.xsd">
  <RESOURCE type="results">
   <INFO ID="QUERY_STATUS" name="QUERY_STATUS" value="OK">OK</INFO>

diff --git a/pyvo/dal/tests/data/query/overflowstatus.xml b/pyvo/dal/tests/data/query/overflowstatus.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- Produced with astropy.io.votable version 5.0.1
-     http://www.astropy.org/ -->
+     https://www.astropy.org/ -->
 <VOTABLE version="1.4" xmlns="http://www.ivoa.net/xml/VOTable/v1.3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.ivoa.net/xml/VOTable/v1.3 http://www.ivoa.net/xml/VOTable/VOTable-1.4.xsd">
  <RESOURCE type="results">
   <INFO ID="QUERY_STATUS" name="QUERY_STATUS" value="OK"/>

diff --git a/pyvo/dal/tests/data/query/rootinfo.xml b/pyvo/dal/tests/data/query/rootinfo.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- Produced with astropy.io.votable version 5.0.1
-     http://www.astropy.org/ -->
+     https://www.astropy.org/ -->
 <VOTABLE version="1.4" xmlns="http://www.ivoa.net/xml/VOTable/v1.3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.ivoa.net/xml/VOTable/v1.3 http://www.ivoa.net/xml/VOTable/VOTable-1.4.xsd">
  <INFO ID="QUERY_STATUS" name="QUERY_STATUS" value="OK">OK</INFO>
  <RESOURCE type="results">

diff --git a/pyvo/dal/tests/data/query/tableinfo.xml b/pyvo/dal/tests/data/query/tableinfo.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- Produced with astropy.io.votable version 5.0.1
-     http://www.astropy.org/ -->
+     https://www.astropy.org/ -->
 <VOTABLE version="1.4" xmlns="http://www.ivoa.net/xml/VOTable/v1.3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.ivoa.net/xml/VOTable/v1.3 http://www.ivoa.net/xml/VOTable/VOTable-1.4.xsd">
  <RESOURCE type="results">
   <TABLE>

diff --git a/pyvo/dal/tests/data/sia/dataset.xml b/pyvo/dal/tests/data/sia/dataset.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- Produced with astropy.io.votable version 3.1.dev21501
-     http://www.astropy.org/ -->
+     https://www.astropy.org/ -->
 <VOTABLE version="1.3" xmlns="http://www.ivoa.net/xml/VOTable/v1.3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.ivoa.net/xml/VOTable/v1.3">
  <RESOURCE type="results">
   <INFO ID="QUERY_STATUS" name="QUERY_STATUS" value="OK">OK</INFO>

diff --git a/pyvo/registry/regtap.py b/pyvo/registry/regtap.py
@@ -109,10 +109,8 @@ def search(*constraints:rtcons.Constraint,
 
     The function accepts query constraints either as Constraint objects
     passed in as positional arguments or as their associated keywords.
-    For what constraints are available, see
-    `Basic Interface`_.
+    For what constraints are available, see ref:`registry_basic_interface`.
 
-    .. _Basic Interface: ../registry/index.html#basic-interface
 
     The values of keyword arguments may be tuples or lists when the associated
     Constraint objects take multiple arguments.

diff --git a/pyvo/registry/rtcons.py b/pyvo/registry/rtcons.py
@@ -326,7 +326,7 @@ class Waveband(Constraint):
 
     This builds a constraint against rr.resource.waveband, i.e.,
     a verbal indication of the messenger particle, coming
-    from the IVOA vocabulary http://www.ivoa.net/messenger.
+    from the IVOA vocabulary http://www.ivoa.net/rdf/messenger.
 
     The :py:class:`pyvo.registry.Spectral` constraint enables selections by particle energy,
     but few resources actually give the necessary metadata (in 2021).
@@ -342,7 +342,7 @@ def __init__(self, *bands):
         Parameters
         ----------
         *bands: tuple of strings
-            One or more of the terms given in http://www.ivoa.net/messenger.
+            One or more of the terms given in http://www.ivoa.net/rdf/messenger.
             The constraint matches when a resource declares at least
             one of the messengers listed.
         """

diff --git a/tox.ini b/tox.ini
@@ -45,28 +45,20 @@ commands =
     cov: pytest --pyargs --cov pyvo --cov-config={toxinidir}/setup.cfg {env:PYTEST_ARGS}
     cov: coverage xml -o {toxinidir}/coverage.xml
 
-[testenv:docs]
-description = builds the docs
-extras = docs
-commands =
-    pip freeze
-    sphinx-build -W -b html . _build/html
-
-
 [testenv:linkcheck]
 changedir = docs
-deps =
-    sphinx_astropy
 description = check the links in the HTML docs
 extras = docs
 commands =
+    pip freeze
     sphinx-build -W -b linkcheck . _build/html
 
 [testenv:build_docs]
 changedir = docs
 description = invoke sphinx-build to build the HTML docs
 extras = docs
 commands =
+    pip freeze
     sphinx-build -W -b html . _build/html
 
 [testenv:codestyle]