Merge pull request #3078 from jepler/redirects-mk2

Make redirects actually work on RTD, redirect __init__.html pages

Author: tannewt

conf.py

@@ -391,12 +391,13 @@
 def generate_redirects(app):
     path = os.path.join(app.srcdir, app.config.redirects_file)
     if not os.path.exists(path):
-        app.info("Could not find redirects file at '%s'" % path)
+        logging.error("Could not find redirects file at '%s'" % path)
         return
 
-    if not type(app.builder) == builders.StandaloneHTMLBuilder:
+    if not isinstance(app.builder, builders.StandaloneHTMLBuilder):
         logging.warn("The 'sphinxcontib-redirects' plugin is only supported "
-                 "by the 'html' builder. Skipping...")
+                 "by the 'html' builder and subclasses. Skipping...")
+        logging.warn(f"Builder is {app.builder.name} ({type(app.builder)})")
         return
 
     with open(path) as redirects:

docs/redirects.txt

@@ -1,15 +1,67 @@
-shared-bindings/frequencyio/FrequencyIn.rst shared-bindings/frequencyio/#frequencyio.FrequencyIn
-shared-bindings/fontio/BuiltinFont.rst shared-bindings/fontio/#fontio.BuiltinFont
-shared-bindings/fontio/Glyph.rst shared-bindings/fontio/#fontio.Glyph
+shared-bindings//__init__.rst shared-bindings//
+shared-bindings/_bleio/Adapter.rst shared-bindings/_bleio/#_bleio.Adapter
+shared-bindings/_bleio/Address.rst shared-bindings/_bleio/#_bleio.Address
+shared-bindings/_bleio/Attribute.rst shared-bindings/_bleio/#_bleio.Attribute
+shared-bindings/_bleio/BluetoothError.rst shared-bindings/_bleio/#_bleio.BluetoothError
+shared-bindings/_bleio/Characteristic.rst shared-bindings/_bleio/#_bleio.Characteristic
+shared-bindings/_bleio/CharacteristicBuffer.rst shared-bindings/_bleio/#_bleio.CharacteristicBuffer
+shared-bindings/_bleio/Connection.rst shared-bindings/_bleio/#_bleio.Connection
+shared-bindings/_bleio/ConnectionError.rst shared-bindings/_bleio/#_bleio.ConnectionError
+shared-bindings/_bleio/Descriptor.rst shared-bindings/_bleio/#_bleio.Descriptor
+shared-bindings/_bleio/PacketBuffer.rst shared-bindings/_bleio/#_bleio.PacketBuffer
+shared-bindings/_bleio/RoleError.rst shared-bindings/_bleio/#_bleio.RoleError
+shared-bindings/_bleio/ScanEntry.rst shared-bindings/_bleio/#_bleio.ScanEntry
+shared-bindings/_bleio/ScanResults.rst shared-bindings/_bleio/#_bleio.ScanResults
+shared-bindings/_bleio/SecurityError.rst shared-bindings/_bleio/#_bleio.SecurityError
+shared-bindings/_bleio/Service.rst shared-bindings/_bleio/#_bleio.Service
+shared-bindings/_bleio/UUID.rst shared-bindings/_bleio/#_bleio.UUID
+shared-bindings/_bleio/__init__.rst shared-bindings/_bleio/
+shared-bindings/_eve/__init__.rst shared-bindings/_eve/
+shared-bindings/_pew/PewPew.rst shared-bindings/_pew/#_pew.PewPew
+shared-bindings/_pew/__init__.rst shared-bindings/_pew/
+shared-bindings/_pixelbuf/PixelBuf.rst shared-bindings/_pixelbuf/#_pixelbuf.PixelBuf
+shared-bindings/_pixelbuf/__init__.rst shared-bindings/_pixelbuf/
+shared-bindings/_stage/Layer.rst shared-bindings/_stage/#_stage.Layer
+shared-bindings/_stage/Text.rst shared-bindings/_stage/#_stage.Text
+shared-bindings/_stage/__init__.rst shared-bindings/_stage/
 shared-bindings/aesio/AES.rst shared-bindings/aesio/#aesio.AES
-shared-bindings/supervisor/Runtime.rst shared-bindings/supervisor/#supervisor.Runtime
-shared-bindings/terminalio/Terminal.rst shared-bindings/terminalio/#terminalio.Terminal
+shared-bindings/aesio/__init__.rst shared-bindings/aesio/
+shared-bindings/analogio/AnalogIn.rst shared-bindings/analogio/#analogio.AnalogIn
+shared-bindings/analogio/AnalogOut.rst shared-bindings/analogio/#analogio.AnalogOut
+shared-bindings/analogio/__init__.rst shared-bindings/analogio/
+shared-bindings/audiobusio/I2SOut.rst shared-bindings/audiobusio/#audiobusio.I2SOut
+shared-bindings/audiobusio/PDMIn.rst shared-bindings/audiobusio/#audiobusio.PDMIn
+shared-bindings/audiobusio/__init__.rst shared-bindings/audiobusio/
+shared-bindings/audiocore/RawSample.rst shared-bindings/audiocore/#audiocore.RawSample
+shared-bindings/audiocore/WaveFile.rst shared-bindings/audiocore/#audiocore.WaveFile
+shared-bindings/audiocore/__init__.rst shared-bindings/audiocore/
+shared-bindings/audioio/AudioOut.rst shared-bindings/audioio/#audioio.AudioOut
+shared-bindings/audioio/__init__.rst shared-bindings/audioio/
+shared-bindings/audiomixer/Mixer.rst shared-bindings/audiomixer/#audiomixer.Mixer
+shared-bindings/audiomixer/MixerVoice.rst shared-bindings/audiomixer/#audiomixer.MixerVoice
+shared-bindings/audiomixer/__init__.rst shared-bindings/audiomixer/
+shared-bindings/audiomp3/MP3.rst shared-bindings/audiomp3/#audiomp3.MP3
+shared-bindings/audiomp3/__init__.rst shared-bindings/audiomp3/
 shared-bindings/audiopwmio/PWMAudioOut.rst shared-bindings/audiopwmio/#audiopwmio.PWMAudioOut
-shared-bindings/gamepadshift/GamePadShift.rst shared-bindings/gamepadshift/#gamepadshift.GamePadShift
-shared-bindings/vectorio/Circle.rst shared-bindings/vectorio/#vectorio.Circle
-shared-bindings/vectorio/Polygon.rst shared-bindings/vectorio/#vectorio.Polygon
-shared-bindings/vectorio/Rectangle.rst shared-bindings/vectorio/#vectorio.Rectangle
-shared-bindings/vectorio/VectorShape.rst shared-bindings/vectorio/#vectorio.VectorShape
+shared-bindings/audiopwmio/__init__.rst shared-bindings/audiopwmio/
+shared-bindings/bitbangio/I2C.rst shared-bindings/bitbangio/#bitbangio.I2C
+shared-bindings/bitbangio/OneWire.rst shared-bindings/bitbangio/#bitbangio.OneWire
+shared-bindings/bitbangio/SPI.rst shared-bindings/bitbangio/#bitbangio.SPI
+shared-bindings/bitbangio/__init__.rst shared-bindings/bitbangio/
+shared-bindings/board/__init__.rst shared-bindings/board/
+shared-bindings/busio/I2C.rst shared-bindings/busio/#busio.I2C
+shared-bindings/busio/OneWire.rst shared-bindings/busio/#busio.OneWire
+shared-bindings/busio/Parity.rst shared-bindings/busio/#busio.Parity
+shared-bindings/busio/SPI.rst shared-bindings/busio/#busio.SPI
+shared-bindings/busio/UART.rst shared-bindings/busio/#busio.UART
+shared-bindings/busio/__init__.rst shared-bindings/busio/
+shared-bindings/countio/Counter.rst shared-bindings/countio/#countio.Counter
+shared-bindings/countio/__init__.rst shared-bindings/countio/
+shared-bindings/digitalio/DigitalInOut.rst shared-bindings/digitalio/#digitalio.DigitalInOut
+shared-bindings/digitalio/Direction.rst shared-bindings/digitalio/#digitalio.Direction
+shared-bindings/digitalio/DriveMode.rst shared-bindings/digitalio/#digitalio.DriveMode
+shared-bindings/digitalio/Pull.rst shared-bindings/digitalio/#digitalio.Pull
+shared-bindings/digitalio/__init__.rst shared-bindings/digitalio/
 shared-bindings/displayio/Bitmap.rst shared-bindings/displayio/#displayio.Bitmap
 shared-bindings/displayio/ColorConverter.rst shared-bindings/displayio/#displayio.ColorConverter
 shared-bindings/displayio/Display.rst shared-bindings/displayio/#displayio.Display
@@ -22,73 +74,88 @@ shared-bindings/displayio/Palette.rst shared-bindings/displayio/#displayio.Palet
 shared-bindings/displayio/ParallelBus.rst shared-bindings/displayio/#displayio.ParallelBus
 shared-bindings/displayio/Shape.rst shared-bindings/displayio/#displayio.Shape
 shared-bindings/displayio/TileGrid.rst shared-bindings/displayio/#displayio.TileGrid
-shared-bindings/_pixelbuf/PixelBuf.rst shared-bindings/_pixelbuf/#_pixelbuf.PixelBuf
+shared-bindings/displayio/__init__.rst shared-bindings/displayio/
+shared-bindings/fontio/BuiltinFont.rst shared-bindings/fontio/#fontio.BuiltinFont
+shared-bindings/fontio/Glyph.rst shared-bindings/fontio/#fontio.Glyph
+shared-bindings/fontio/__init__.rst shared-bindings/fontio/
+shared-bindings/framebufferio/FramebufferDisplay.rst shared-bindings/framebufferio/#framebufferio.FramebufferDisplay
+shared-bindings/framebufferio/__init__.rst shared-bindings/framebufferio/
+shared-bindings/frequencyio/FrequencyIn.rst shared-bindings/frequencyio/#frequencyio.FrequencyIn
+shared-bindings/frequencyio/__init__.rst shared-bindings/frequencyio/
 shared-bindings/gamepad/GamePad.rst shared-bindings/gamepad/#gamepad.GamePad
-shared-bindings/_pew/PewPew.rst shared-bindings/_pew/#_pew.PewPew
-shared-bindings/rotaryio/IncrementalEncoder.rst shared-bindings/rotaryio/#rotaryio.IncrementalEncoder
-shared-bindings/audiomixer/Mixer.rst shared-bindings/audiomixer/#audiomixer.Mixer
-shared-bindings/audiomixer/MixerVoice.rst shared-bindings/audiomixer/#audiomixer.MixerVoice
-shared-bindings/pulseio/PWMOut.rst shared-bindings/pulseio/#pulseio.PWMOut
-shared-bindings/pulseio/PulseIn.rst shared-bindings/pulseio/#pulseio.PulseIn
-shared-bindings/pulseio/PulseOut.rst shared-bindings/pulseio/#pulseio.PulseOut
-shared-bindings/time/struct_time.rst shared-bindings/time/#time.struct_time
+shared-bindings/gamepad/__init__.rst shared-bindings/gamepad/
+shared-bindings/gamepadshift/GamePadShift.rst shared-bindings/gamepadshift/#gamepadshift.GamePadShift
+shared-bindings/gamepadshift/__init__.rst shared-bindings/gamepadshift/
+shared-bindings/gnss/__init__.rst shared-bindings/gnss/
+shared-bindings/i2cperipheral/__init__.rst shared-bindings/i2cperipheral/
+shared-bindings/i2csecondary/__init__.rst shared-bindings/i2csecondary/
 shared-bindings/i2cslave/I2CSlave.rst shared-bindings/i2cperipheral/#i2cperipheral.I2CPeripheral
 shared-bindings/i2cslave/I2CSlaveRequest.rst shared-bindings/i2cperipheral/#i2cperipheral.I2CPeripheralRequest
+shared-bindings/math/__init__.rst shared-bindings/math/
+shared-bindings/microcontroller/Pin.rst shared-bindings/microcontroller/#microcontroller.Pin
+shared-bindings/microcontroller/Processor.rst shared-bindings/microcontroller/#microcontroller.Processor
+shared-bindings/microcontroller/RunMode.rst shared-bindings/microcontroller/#microcontroller.RunMode
+shared-bindings/microcontroller/__init__.rst shared-bindings/microcontroller/
+shared-bindings/multiterminal/__init__.rst shared-bindings/multiterminal/
+shared-bindings/neopixel_write/__init__.rst shared-bindings/neopixel_write/
+shared-bindings/network/__init__.rst shared-bindings/network/
 shared-bindings/nvm/ByteArray.rst shared-bindings/nvm/#nvm.ByteArray
-shared-bindings/busio/I2C.rst shared-bindings/busio/#busio.I2C
-shared-bindings/busio/OneWire.rst shared-bindings/busio/#busio.OneWire
-shared-bindings/busio/SPI.rst shared-bindings/busio/#busio.SPI
-shared-bindings/busio/UART.rst shared-bindings/busio/#busio.UART
-shared-bindings/busio/Parity.rst shared-bindings/busio/#busio.Parity
-shared-bindings/ulab/array.rst shared-bindings/ulab/#ulab.array
-shared-bindings/watchdog/WatchDogMode.rst shared-bindings/watchdog/#watchdog.WatchDogMode
-shared-bindings/watchdog/WatchDogTimer.rst shared-bindings/watchdog/#watchdog.WatchDogTimer
-shared-bindings/audioio/AudioOut.rst shared-bindings/audioio/#audioio.AudioOut
+shared-bindings/nvm/__init__.rst shared-bindings/nvm/
+shared-bindings/os/__init__.rst shared-bindings/os/
+shared-bindings/protomatter/__init__.rst shared-bindings/protomatter/
 shared-bindings/ps2io/Ps2.rst shared-bindings/ps2io/#ps2io.Ps2
-shared-bindings/touchio/TouchIn.rst shared-bindings/touchio/#touchio.TouchIn
+shared-bindings/ps2io/__init__.rst shared-bindings/ps2io/
+shared-bindings/pulseio/PWMOut.rst shared-bindings/pulseio/#pulseio.PWMOut
+shared-bindings/pulseio/PulseIn.rst shared-bindings/pulseio/#pulseio.PulseIn
+shared-bindings/pulseio/PulseOut.rst shared-bindings/pulseio/#pulseio.PulseOut
+shared-bindings/pulseio/__init__.rst shared-bindings/pulseio/
+shared-bindings/random/__init__.rst shared-bindings/random/
 shared-bindings/rgbmatrix/RGBMatrix.rst shared-bindings/rgbmatrix/#rgbmatrix.RGBMatrix
-shared-bindings/audiomp3/MP3.rst shared-bindings/audiomp3/#audiomp3.MP3
+shared-bindings/rgbmatrix/__init__.rst shared-bindings/rgbmatrix/
+shared-bindings/rotaryio/IncrementalEncoder.rst shared-bindings/rotaryio/#rotaryio.IncrementalEncoder
+shared-bindings/rotaryio/__init__.rst shared-bindings/rotaryio/
+shared-bindings/rtc/RTC.rst shared-bindings/rtc/#rtc.RTC
+shared-bindings/rtc/__init__.rst shared-bindings/rtc/
+shared-bindings/samd/Clock.rst shared-bindings/samd/#samd.Clock
+shared-bindings/samd/__init__.rst shared-bindings/samd/
+shared-bindings/socket/__init__.rst shared-bindings/socket/
+shared-bindings/socket/socket.rst shared-bindings/socket/#socket.socket
+shared-bindings/storage/VfsFat.rst shared-bindings/storage/#storage.VfsFat
+shared-bindings/storage/__init__.rst shared-bindings/storage/
+shared-bindings/struct/__init__.rst shared-bindings/struct/
+shared-bindings/supervisor/Runtime.rst shared-bindings/supervisor/#supervisor.Runtime
+shared-bindings/supervisor/__init__.rst shared-bindings/supervisor/
+shared-bindings/terminalio/Terminal.rst shared-bindings/terminalio/#terminalio.Terminal
+shared-bindings/terminalio/__init__.rst shared-bindings/terminalio/
+shared-bindings/time/__init__.rst shared-bindings/time/
+shared-bindings/time/struct_time.rst shared-bindings/time/#time.struct_time
+shared-bindings/touchio/TouchIn.rst shared-bindings/touchio/#touchio.TouchIn
+shared-bindings/touchio/__init__.rst shared-bindings/touchio/
+shared-bindings/uheap/__init__.rst shared-bindings/uheap/
+shared-bindings/ulab/__init__.rst shared-bindings/ulab/
+shared-bindings/ulab/approx/__init__.rst shared-bindings/ulab/approx/
+shared-bindings/ulab/array.rst shared-bindings/ulab/#ulab.array
+shared-bindings/ulab/compare/__init__.rst shared-bindings/ulab/compare/
+shared-bindings/ulab/extras/__init__.rst shared-bindings/ulab/extras/
+shared-bindings/ulab/fft/__init__.rst shared-bindings/ulab/fft/
+shared-bindings/ulab/filter/__init__.rst shared-bindings/ulab/filter/
+shared-bindings/ulab/linalg/__init__.rst shared-bindings/ulab/linalg/
+shared-bindings/ulab/numerical/__init__.rst shared-bindings/ulab/numerical/
+shared-bindings/ulab/poly/__init__.rst shared-bindings/ulab/poly/
+shared-bindings/ulab/vector/__init__.rst shared-bindings/ulab/vector/
+shared-bindings/usb_hid/Device.rst shared-bindings/usb_hid/#usb_hid.Device
+shared-bindings/usb_hid/__init__.rst shared-bindings/usb_hid/
 shared-bindings/usb_midi/PortIn.rst shared-bindings/usb_midi/#usb_midi.PortIn
 shared-bindings/usb_midi/PortOut.rst shared-bindings/usb_midi/#usb_midi.PortOut
-shared-bindings/usb_hid/Device.rst shared-bindings/usb_hid/#usb_hid.Device
+shared-bindings/usb_midi/__init__.rst shared-bindings/usb_midi/
+shared-bindings/ustack/__init__.rst shared-bindings/ustack/
+shared-bindings/vectorio/Circle.rst shared-bindings/vectorio/#vectorio.Circle
+shared-bindings/vectorio/Polygon.rst shared-bindings/vectorio/#vectorio.Polygon
+shared-bindings/vectorio/Rectangle.rst shared-bindings/vectorio/#vectorio.Rectangle
+shared-bindings/vectorio/VectorShape.rst shared-bindings/vectorio/#vectorio.VectorShape
+shared-bindings/vectorio/__init__.rst shared-bindings/vectorio/
+shared-bindings/watchdog/WatchDogMode.rst shared-bindings/watchdog/#watchdog.WatchDogMode
+shared-bindings/watchdog/WatchDogTimer.rst shared-bindings/watchdog/#watchdog.WatchDogTimer
+shared-bindings/watchdog/__init__.rst shared-bindings/watchdog/
 shared-bindings/wiznet/WIZNET5K.rst shared-bindings/wiznet/#wiznet.WIZNET5K
-shared-bindings/_bleio/BluetoothError.rst shared-bindings/_bleio/#_bleio.BluetoothError
-shared-bindings/_bleio/ConnectionError.rst shared-bindings/_bleio/#_bleio.ConnectionError
-shared-bindings/_bleio/RoleError.rst shared-bindings/_bleio/#_bleio.RoleError
-shared-bindings/_bleio/SecurityError.rst shared-bindings/_bleio/#_bleio.SecurityError
-shared-bindings/_bleio/Adapter.rst shared-bindings/_bleio/#_bleio.Adapter
-shared-bindings/_bleio/Address.rst shared-bindings/_bleio/#_bleio.Address
-shared-bindings/_bleio/Attribute.rst shared-bindings/_bleio/#_bleio.Attribute
-shared-bindings/_bleio/Characteristic.rst shared-bindings/_bleio/#_bleio.Characteristic
-shared-bindings/_bleio/CharacteristicBuffer.rst shared-bindings/_bleio/#_bleio.CharacteristicBuffer
-shared-bindings/_bleio/Connection.rst shared-bindings/_bleio/#_bleio.Connection
-shared-bindings/_bleio/Descriptor.rst shared-bindings/_bleio/#_bleio.Descriptor
-shared-bindings/_bleio/PacketBuffer.rst shared-bindings/_bleio/#_bleio.PacketBuffer
-shared-bindings/_bleio/ScanEntry.rst shared-bindings/_bleio/#_bleio.ScanEntry
-shared-bindings/_bleio/ScanResults.rst shared-bindings/_bleio/#_bleio.ScanResults
-shared-bindings/_bleio/Service.rst shared-bindings/_bleio/#_bleio.Service
-shared-bindings/_bleio/UUID.rst shared-bindings/_bleio/#_bleio.UUID
-shared-bindings/socket/socket.rst shared-bindings/socket/#socket.socket
-shared-bindings/microcontroller/Pin.rst shared-bindings/microcontroller/#microcontroller.Pin
-shared-bindings/microcontroller/Processor.rst shared-bindings/microcontroller/#microcontroller.Processor
-shared-bindings/microcontroller/RunMode.rst shared-bindings/microcontroller/#microcontroller.RunMode
-shared-bindings/audiocore/RawSample.rst shared-bindings/audiocore/#audiocore.RawSample
-shared-bindings/audiocore/WaveFile.rst shared-bindings/audiocore/#audiocore.WaveFile
-shared-bindings/framebufferio/FramebufferDisplay.rst shared-bindings/framebufferio/#framebufferio.FramebufferDisplay
-shared-bindings/audiobusio/I2SOut.rst shared-bindings/audiobusio/#audiobusio.I2SOut
-shared-bindings/audiobusio/PDMIn.rst shared-bindings/audiobusio/#audiobusio.PDMIn
-shared-bindings/countio/Counter.rst shared-bindings/countio/#countio.Counter
-shared-bindings/storage/VfsFat.rst shared-bindings/storage/#storage.VfsFat
-shared-bindings/digitalio/DigitalInOut.rst shared-bindings/digitalio/#digitalio.DigitalInOut
-shared-bindings/digitalio/Direction.rst shared-bindings/digitalio/#digitalio.Direction
-shared-bindings/digitalio/DriveMode.rst shared-bindings/digitalio/#digitalio.DriveMode
-shared-bindings/digitalio/Pull.rst shared-bindings/digitalio/#digitalio.Pull
-shared-bindings/bitbangio/I2C.rst shared-bindings/bitbangio/#bitbangio.I2C
-shared-bindings/bitbangio/OneWire.rst shared-bindings/bitbangio/#bitbangio.OneWire
-shared-bindings/bitbangio/SPI.rst shared-bindings/bitbangio/#bitbangio.SPI
-shared-bindings/rtc/RTC.rst shared-bindings/rtc/#rtc.RTC
-shared-bindings/analogio/AnalogIn.rst shared-bindings/analogio/#analogio.AnalogIn
-shared-bindings/analogio/AnalogOut.rst shared-bindings/analogio/#analogio.AnalogOut
-shared-bindings/_stage/Layer.rst shared-bindings/_stage/#_stage.Layer
-shared-bindings/_stage/Text.rst shared-bindings/_stage/#_stage.Text
-shared-bindings/samd/Clock.rst shared-bindings/samd/#samd.Clock
+shared-bindings/wiznet/__init__.rst shared-bindings/wiznet/