docs: linkcheck, prune some stale text

minrk · minrk · commit 69da8aacb1eb · 2022-03-02T08:49:02.000+01:00
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -473,7 +473,7 @@ Changes:
    - catch EACCES on Windows
 - include libsodium when building bundled libzmq on Windows (includes wheels on PyPI)
 - pyzmq no longer bundles external libzmq when making a bdist.
-  You can use `delocate <https://pypi.python.org/pypi/delocate>`_ to do this.
+  You can use `delocate <https://pypi.org/project/delocate/>`_ to do this.
 
 Bugfixes:
 
@@ -584,7 +584,7 @@ security features.
   ensuring that libzmq security is available to users who install from wheels
 - New :mod:`zmq.auth`, implementing zeromq's ZAP authentication,
   modeled on czmq zauth.
-  For more information, see the `examples <https://github.com/zeromq/pyzmq/tree/master/examples/>`_.
+  For more information, see the `examples <https://github.com/zeromq/pyzmq/tree/HEAD/examples/>`_.
 
 
 Other New Stuff
@@ -769,8 +769,8 @@ both used under the LGPL.
 zmq.green
 *********
 
-The excellent `gevent_zeromq <https://github.com/traviscline/gevent_zeromq>`_ socket
-subclass which provides `gevent <http://www.gevent.org/>`_ compatibility has been merged as
+The excellent `gevent_zeromq <https://github.com/tmc/gevent-zeromq>`_ socket
+subclass which provides `gevent <https://www.gevent.org/>`_ compatibility has been merged as
 :mod:`zmq.green`.
 
 .. seealso::
@@ -914,7 +914,7 @@ set in stone, and may be removed or changed in incompatible ways in later releas
   :func:`~zmq.core.version.pyzmq_version_info` for getting libzmq and pyzmq versions as
   tuples of numbers. This helps with the fact that version string comparison breaks down
   once versions get into double-digits.
-* ioloop changes merged from upstream `Tornado <http://www.tornadoweb.org>`_ 2.1
+* ioloop changes merged from upstream `Tornado <https://www.tornadoweb.org>`_ 2.1
 
 2.1.9
 =====
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -59,7 +59,7 @@
 
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3', None),
-    'tornado': ('http://www.tornadoweb.org/en/stable', None),
+    'tornado': ('https://www.tornadoweb.org/en/stable', None),
 }
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
diff --git a/docs/source/devices.rst b/docs/source/devices.rst
@@ -7,7 +7,7 @@ Devices in PyZMQ
 
 .. seealso::
 
-    ØMQ Guide `Device coverage <http://zguide.zeromq.org/chapter:all#toc32>`_.
+    ØMQ Guide `Device coverage <https://zguide.zeromq.org/docs/chapter2/#ZeroMQ-s-Built-In-Proxy-Function>`_.
 
 ØMQ has a notion of Devices - simple programs that manage a send-recv pattern for
 connecting two or more sockets. Being full programs, devices include a ``while(True)``
@@ -32,7 +32,7 @@ objects created in the background thread or process, prefixed with 'in\_' or 'ou
 corresponding to the `in_socket` and `out_socket`::
 
     from zmq.devices import ProcessDevice
-    
+
     pd = ProcessDevice(zmq.QUEUE, zmq.ROUTER, zmq.DEALER)
     pd.bind_in('tcp://*:12345')
     pd.connect_out('tcp://127.0.0.1:12543')
diff --git a/docs/source/eventloop.rst b/docs/source/eventloop.rst
@@ -249,7 +249,7 @@ You can also manually install this IOLoop as the global tornado instance, with:
 PyZMQ and gevent
 ================
 
-PyZMQ ≥ 2.2.0.1 ships with a `gevent <http://www.gevent.org/>`_ compatible API as :mod:`zmq.green`.
+PyZMQ ≥ 2.2.0.1 ships with a `gevent <https://www.gevent.org/>`_ compatible API as :mod:`zmq.green`.
 To use it, simply:
 
 .. sourcecode:: python
@@ -280,7 +280,7 @@ though using two eventloops simultaneously (tornado + gevent) is not recommended
 
 .. seealso::
 
-    zmq.green examples `on GitHub <https://github.com/zeromq/pyzmq/tree/master/examples/gevent>`_.
+    zmq.green examples `on GitHub <https://github.com/zeromq/pyzmq/tree/HEAD/examples/gevent>`_.
 
-:mod:`zmq.green` is simply `gevent_zeromq <https://github.com/traviscline/gevent_zeromq>`_,
+:mod:`zmq.green` began as `gevent_zeromq <https://github.com/tmc/gevent-zeromq>`_,
 merged into the pyzmq project.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,8 +1,3 @@
-.. PyZMQ documentation master file, created by
-   sphinx-quickstart on Sat Feb 20 23:31:19 2010.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 PyZMQ Documentation
 ===================
 
@@ -28,18 +23,17 @@ General questions about ØMQ are better sent to the `ØMQ tracker`_ or `mailing
 Supported LibZMQ
 ================
 
-PyZMQ aims to support all stable ( ≥2.1.4, ≥ 3.2.2, ≥ 4.0.1 ) and active development ( ≥ 4.2.0 )
+PyZMQ aims to support all stable (≥ 3.2.2, ≥ 4.0.1 )
 versions of libzmq.  Building the same pyzmq against various versions of libzmq is supported,
 but only the functionality of the linked libzmq will be available.
 
 .. note::
 
-    libzmq 3.0-3.1 are not, and will never be supported.
-    There never was a stable release of either.
+    libzmq 3.0-3.1 are not supported,
+    as they never received a stable release.
 
 
-Binary distributions (wheels on `PyPI <http://pypi.python.org/pypi/pyzmq>`__
-or `GitHub <https://www.github.com/zeromq/pyzmq/downloads>`__) of PyZMQ ship with
+Binary distributions (wheels on `PyPI <https://pypi.org/project/pyzmq/>`__) of PyZMQ ship with
 the stable version of libzmq at the time of release, built with default configuration,
 and include CURVE support provided by tweetnacl.
 For pyzmq-|release|, this is |target_libzmq|.
@@ -87,17 +81,13 @@ Links
 
 * ØMQ_ Home
 * The `ØMQ Guide`_
-* `PyZMQ Installation`_ notes on the ZeroMQ website
 * PyZMQ on GitHub_
 * Issue Tracker_
 
-.. _ØMQ: http://www.zeromq.org
-.. _ØMQ Guide: http://zguide.zeromq.org
+.. _ØMQ: https://zeromq.org/
+.. _ØMQ Guide: https://zguide.zeromq.org
 .. _ØMQ Tracker: https://github.com/zeromq/libzmq/issues
-.. _mailing list: http://www.zeromq.org/docs:mailing-lists
-.. _IRC Channel: http://www.zeromq.org/chatroom
-.. _Cython: http://cython.org/
-.. _GitHub: https://www.github.com/zeromq/pyzmq
-.. _ØMQ Manual: http://www.zeromq.org/intro:read-the-manual
-.. _PyZMQ Installation: http://www.zeromq.org/bindings:python
-.. _tracker: https://www.github.com/zeromq/pyzmq/issues
+.. _mailing list: http://wiki.zeromq.org/docs:mailing-lists
+.. _Cython: https://cython.org/
+.. _GitHub: https://github.com/zeromq/pyzmq
+.. _tracker: https://github.com/zeromq/pyzmq/issues
diff --git a/docs/source/logging.rst b/docs/source/logging.rst
@@ -7,23 +7,23 @@ Asynchronous Logging via PyZMQ
 
 .. seealso::
 
-    * The ØMQ guide `coverage <http://zguide.zeromq.org/chapter:all#toc7>`_ of PUB/SUB
+    * The ØMQ guide `coverage <https://zguide.zeromq.org/docs/chapter5/>`_ of PUB/SUB
       messaging
-    * Python logging module `documentation <http://docs.python.org/library/logging.html>`_
+    * Python logging module `documentation <https://docs.python.org/3/library/logging.html>`_
 
 Python provides extensible logging facilities through its :py:mod:`logging` module. This
 module allows for easily extensible logging functionality through the use of
 :py:class:`~logging.Handler` objects. The most obvious case for hooking up pyzmq to
 logging would be to broadcast log messages over a PUB socket, so we have provided a
 :class:`.PUBHandler` class for doing just that.
 
-You can use PyZMQ as a log handler with no previous knowledge of how ZMQ works, 
+You can use PyZMQ as a log handler with no previous knowledge of how ZMQ works,
 and without writing any ZMQ-specific code in your Python project.
 
 Getting Started
 ---------------
-Ensure you have installed the pyzmq package from pip, ideally in a 
-`virtual environment <https://docs.python.org/3/library/venv.html>`_ 
+Ensure you have installed the pyzmq package from pip, ideally in a
+`virtual environment <https://docs.python.org/3/library/venv.html>`_
 you created for your project::
 
     pip install pyzmq
@@ -40,7 +40,7 @@ Next, configure logging in your Python module and setup the ZMQ log handler::
 Usually, you will add the handler only once in the top-level module of your
 project, on the root logger, just as we did here.
 
-You can choose any IP address and port number that works on your system. We 
+You can choose any IP address and port number that works on your system. We
 used ``tcp://127.0.0.1:12345`` to broadcast events via TCP on the localhost
 interface at port 12345. Make note of what you choose here as you will need it
 later when you listen to the events.
@@ -81,29 +81,29 @@ Slow Joiner Problem
 *******************
 The great thing about using ZMQ sockets is that you can start the publisher
 and subscribers in any order, and you can start & stop any of them while
-you leave the others running. 
+you leave the others running.
 
 When using ZMQ for logging, this means you
 can leave the log watcher running while you start & stop your main
 Python module.
 
 However, you need to be aware of what the ZMQ project calls the
-`"slow joiner problem" <http://zguide.zeromq.org/page:all#Getting-the-Message-Out>`_ . 
+`"slow joiner problem" <https://zguide.zeromq.org/docs/chapter5/#Slow-Subscriber-Detection-Suicidal-Snail-Pattern>`_ .
 To oversimplify, it means it can take a bit of
 time for subscribers to re-connect to a publisher that has just
 started up again. If the publisher starts and immediately sends a
 message, subscribers will likely miss it.
 
-The simplistic workaround when using PyZMQ for logging is to ``sleep()`` 
+The simplistic workaround when using PyZMQ for logging is to ``sleep()``
 briefly after startup, before sending any log messages. See the complete
 example below for more details.
 
 
 Custom Log Formats
 ******************
-A common Python logging recipe encourages 
+A common Python logging recipe encourages
 `use of the current module name
-<https://docs.python.org/howto/logging-cookbook.html#using-logging-in-multiple-modules>`_
+<https://docs.python.org/3/howto/logging-cookbook.html#using-logging-in-multiple-modules>`_
 as the name of the logger. This allows your log messages to reflect your
 code hierarchy in a larger project with minimal configuration.
 
diff --git a/docs/source/morethanbindings.rst b/docs/source/morethanbindings.rst
@@ -202,5 +202,5 @@ included in PyZMQ itself:
   with ØMQ sockets.
 * :ref:`zmq.ssh <ssh>` : Simple tools for tunneling zeromq connections via ssh.
 
-.. _ØMQ: http://www.zeromq.org
-.. _Tornado: https://github.com/facebook/tornado
+.. _ØMQ: https://zeromq.org/
+.. _Tornado: https://www.tornadoweb.org
diff --git a/docs/source/pyversions.rst b/docs/source/pyversions.rst
@@ -67,7 +67,7 @@ Explicit Type           2.x                      3.x
 =================  =================   ====================
 
 .. Note::
-    
+
     2.5 specific
 
     Where we really noticed the issue of :class:`bytes` vs :obj:`strings` coming up for
@@ -123,9 +123,11 @@ We have a :file:`utils/buffers.pxd` file that defines our :func:`asbuffer` and
 :file:`asbuffer.pxi`. The :func:`frombuffer` functionality was added. These functions
 internally switch based on Python version to call the appropriate C-API functions.
 
-.. seealso:: `Python Buffer API <bufferapi>`_
+.. seealso::
+
+    `Python Buffer API`_
 
-.. _bufferapi: http://docs.python.org/c-api/buffer.html
+.. _Python Buffer API: https://docs.python.org/3/c-api/buffer.html
 
 
 ``__str__``
@@ -153,7 +155,7 @@ Exceptions
 
     This section is only relevant for supporting Python 2.5 and 3.x, not for 2.6-3.x.
 
-The syntax for handling exceptions has `changed <PEP-3110>`_ in Python 3.  The old syntax:
+The syntax for handling exceptions has `changed <https://www.python.org/dev/peps/pep-3110/>`_ in Python 3.  The old syntax:
 
 .. sourcecode:: py
 
@@ -187,9 +189,10 @@ exception block:
 This is certainly not as elegant as either the old or new syntax, but it's the only way we
 have found to work everywhere.
 
-.. seealso:: PEP-3110_
+.. seealso::
+
+    `PEP 3110 <https://www.python.org/dev/peps/pep-3110/>`_
 
-.. _PEP-3110: http://www.python.org/dev/peps/pep-3110/
 
 
-.. _mpi4py: http://mpi4py.googlecode.com
+.. _mpi4py: https://mpi4py.readthedocs.io
diff --git a/docs/source/serialization.rst b/docs/source/serialization.rst
@@ -85,7 +85,7 @@ the array.
         return A.reshape(md['shape'])
 
 
-.. [msgpack] Message Pack serialization library http://msgpack.org
-.. [protobuf] Google Protocol Buffers http://code.google.com/p/protobuf
+.. [msgpack] Message Pack serialization library https://msgpack.org
+.. [protobuf] Google Protocol Buffers https://github.com/protocolbuffers/protobuf
 .. [zlib] Python stdlib module for zip compression: :py:mod:`zlib`
-.. [blosc] Blosc: A blocking, shuffling and loss-less (and crazy-fast) compression library http://www.blosc.org
+.. [blosc] Blosc: A blocking, shuffling and loss-less (and crazy-fast) compression library https://www.blosc.org
diff --git a/docs/source/ssh.rst b/docs/source/ssh.rst
@@ -18,7 +18,7 @@ using paramiko_ for tunnels, so it should work on Windows.
 An SSH tunnel has five basic components:
 
 * server : the SSH server through which the tunnel will be created
-* remote ip : the IP of the remote machine *as seen from the server* 
+* remote ip : the IP of the remote machine *as seen from the server*
   (remote ip may be, but is not not generally the same machine as server).
 * remote port : the port on the remote machine that you want to connect to.
 * local ip : the interface on your local machine you want to use (default: 127.0.0.1)
@@ -65,10 +65,9 @@ rather than the remote one that wouldn't actually work.
 
 .. seealso::
 
-    A short discussion of ssh tunnels: http://www.revsys.com/writings/quicktips/ssh-tunnel.html
+    A short discussion of ssh tunnels: https://www.revsys.com/writings/quicktips/ssh-tunnel.html
 
 
-.. _IPython: http://ipython.org
-.. _pexpect: http://www.noah.org/wiki/pexpect
-.. _pexpect-u: http://pypi.python.org/pypi/pexpect-u
-.. _paramiko: http://www.lag.net/paramiko/
+.. _IPython: https://ipython.org
+.. _pexpect: https://pexpect.readthedocs.io
+.. _paramiko: https://www.lag.net/paramiko/
diff --git a/zmq/log/handlers.py b/zmq/log/handlers.py
@@ -17,7 +17,7 @@
 
 Code adapted from StarCluster:
 
-    http://github.com/jtriley/StarCluster/blob/master/starcluster/logger.py
+    https://github.com/jtriley/StarCluster/blob/StarCluster-0.91/starcluster/logger.py
 """
 
 import logging

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@`
`59`	`59`
`60`	`60`	`intersphinx_mapping = {`
`61`	`61`	`'python': ('https://docs.python.org/3', None),`
`62`		`- 'tornado': ('http://www.tornadoweb.org/en/stable', None),`
	`62`	`+ 'tornado': ('https://www.tornadoweb.org/en/stable', None),`
`63`	`63`	`}`
`64`	`64`	`# The version info for the project you're documenting, acts as replacement for`
`65`	`65`	`# \|version\| and \|release\|, also used in various other places throughout the`