8000 Fix links. Adding the en/latest/ circumvents a ReadTheDocs bug · flummer/circuitpython@4f55205 · GitHub
[go: up one dir, main page]
Skip to content

Commit 4f55205

Browse files
tannewttannewt
committed
Fix links. Adding the en/latest/ circumvents a ReadTheDocs bug
which redirects projects incorrectly.
1 parent f16619a commit 4f55205

File tree

1 file changed

+74
-73
lines changed

1 file changed

+74
-73
lines changed

‎docs/drivers.rst

Lines changed: 74 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,16 @@ These libraries build on top of the low level APIs to simplify common tasks.
5656

5757
.. toctree::
5858

59-
USB Human Interface Device (Keyboard and Mouse) <https://circuitpython.readthedocs.io/projects/hid/>
60-
Waveform Generation <https://circuitpython.readthedocs.io/projects/waveform/>
61-
OneWire <https://circuitpython.readthedocs.io/projects/onewire/>
62-
Ring Tone Text Transfer Language (RTTTL) <https://circuitpython.readthedocs.io/projects/rtttl/>
63-
InfraRed Remote <https://circuitpython.readthedocs.io/projects/irremote/>
64-
Fancy LED (similar to FastLED) <https://circuitpython.readthedocs.io/projects/fancyled/>
65-
SimpleIO <https://circuitpython.readthedocs.io/projects/simpleio/>
66-
AVR programming <https://circuitpython.readthedocs.io/projects/avrprog/>
67-
DC Motor and Servo <https://circuitpython.readthedocs.io/projects/motor/>
68-
SD Card <https://circuitpython.readthedocs.io/projects/sd/>
59+
USB Human Interface Device (Keyboard and Mouse) <https://circuitpython.readthedocs.io/projects/hid/en/latest/>
60+
Waveform Generation <https://circuitpython.readthedocs.io/projects/waveform/en/latest/>
61+
OneWire <https://circuitpython.readthedocs.io/projects/onewire/en/latest/>
62+
Ring Tone Text Transfer Language (RTTTL) <https://circuitpython.readthedocs.io/projects/rtttl/en/latest/>
63+
InfraRed Remote <https://circuitpython.readthedocs.io/projects/irremote/en/latest/>
64+
Fancy LED (similar to FastLED) <https://circuitpython.readthedocs.io/projects/fancyled/en/latest/>
65+
SimpleIO <https://circuitpython.readthedocs.io/projects/simpleio/en/latest/>
66+
AVR programming <https://circuitpython.readthedocs.io/projects/avrprog/en/latest/>
67+
DC Motor and Servo <https://circuitpython.readthedocs.io/projects/motor/en/latest/>
68+
SD Card <https://circuitpython.readthedocs.io/projects/sd/en/latest/>
6969

7070
Blinky
7171
--------
@@ -74,8 +74,8 @@ Multi-color led drivers.
7474

7575
.. toctree::
7676

77-
NeoPixel <https://circuitpython.readthedocs.io/projects/neopixel/>
78-
DotStar <https://circuitpython.readthedocs.io/projects/dotstar/>
77+
NeoPixel <https://circuitpython.readthedocs.io/projects/neopixel/en/latest/>
78+
DotStar <https://circuitpython.readthedocs.io/projects/dotstar/en/latest/>
7979

8080
Displays
8181
-------------
@@ -84,12 +84,12 @@ Drivers used to display information. Either pixel or segment based.
8484

8585
.. toctree::
8686

87-
RGB Displays <https://circuitpython.readthedocs.io/projects/rgb_display/>
88-
Character LCD <https://circuitpython.readthedocs.io/projects/charlcd/>
89-
HT16K33 LED Matrices and Segment Displays <https://circuitpython.readthedocs.io/projects/ht16k33/>
90-
IS31FL3731 Charlieplexed LED Matrix <https://circuitpython.readthedocs.io/projects/is31fl3731/>
91-
MAX7219 LED Matrix <https://circuitpython.readthedocs.io/projects/max7219/>
92-
SSD1306 OLED Driver <https://circuitpython.readthedocs.io/projects/ssd1306/>
87+
RGB Displays <https://circuitpython.readthedocs.io/projects/rgb_display/en/latest/>
88+
Character LCD <https://circuitpython.readthedocs.io/projects/charlcd/en/latest/>
89+
HT16K33 LED Matrices and Segment Displays <https://circuitpython.readthedocs.io/projects/ht16k33/en/latest/>
90+
IS31FL3731 Charlieplexed LED Matrix <https://circuitpython.readthedocs.io/projects/is31fl3731/en/latest/>
91+
MAX7219 LED Matrix <https://circuitpython.readthedocs.io/projects/max7219/en/latest/>
92+
SSD1306 OLED Driver <https://circuitpython.readthedocs.io/projects/ssd1306/en/latest/>
9393

9494
Real-time clocks
9595
-----------------
@@ -99,25 +99,26 @@ through ``datetime``.
9999

100100
.. toctree::
101101

102-
DS1307 Real-time Clock (5V RTC Breakout) <https://circuitpython.readthedocs.io/projects/ds1307/>
103-
DS3231 Real-time Clock (Precision RTC) <https://circuitpython.readthedocs.io/projects/ds3231/>
104-
PCF8523 Real-time Clock (Adalogger RTC) <https://circuitpython.readthedocs.io/projects/pcf8523/>
102+
DS1307 Real-time Clock (5V RTC Breakout) <https://circuitpython.readthedocs.io/projects/ds1307/en/latest/>
103+
DS3231 Real-time Clock (Precision RTC) <https://circuitpython.readthedocs.io/projects/ds3231/en/latest/>
104+
PCF8523 Real-time Clock (Adalogger RTC) <https://circuitpython.readthedocs.io/projects/pcf8523/en/latest/>
105105

106106
Motion Sensors
107107
----------------
108108

109109
Motion relating sensing including ``acceleration``, ``magnetic``, ``gyro``, and ``orientation``.
110110

111111
.. toctree::
112-
BNO055 Accelerometer, Magnetometer, Gyroscope and Absolution Orientation <https://circuitpython.readthedocs.io/projects/bno055/>
113-
FXAS21002C Gyroscope <https://circuitpython.readthedocs.io/projects/fxas21002C/>
114-
FXOS8700 Accelerometer <https://circuitpython.readthedocs.io/projects/fxos8700/>
115-
GPS Global Position <https://circuitpython.readthedocs.io/projects/gps/>
116-
LIS3DH Accelerometer <https://circuitpython.readthedocs.io/projects/lis3dh/>
117-
LSM303 Accelerometer and Magnetometer <https://circuitpython.readthedocs.io/projects/lsm303/>
118-
LSM9DS0 Accelerometer, Magnetometer, Gyroscope and Temperature <https://circuitpython.readthedocs.io/projects/lsm9ds0/>
119-
LSM9DS1 Accelerometer, Magnetometer, Gyroscope and Temperature <https://circuitpython.readthedocs.io/projects/lsm9ds1/>
120-
MMA8451 3 axis accelerometer <https://circuitpython.readthedocs.io/projects/mma8451/>
112+
113+
BNO055 Accelerometer, Magnetometer, Gyroscope and Absolution Orientation <https://circuitpython.readthedocs.io/projects/bno055/en/latest/>
114+
FXAS21002C Gyroscope <https://circuitpython.readthedocs.io/projects/fxas21002C/en/latest/>
115+
FXOS8700 Accelerometer <https://circuitpython.readthedocs.io/projects/fxos8700/en/latest/>
116+
GPS Global Position <https://circuitpython.readthedocs.io/projects/gps/en/latest/>
117+
LIS3DH Accelerometer <https://circuitpython.readthedocs.io/projects/lis3dh/en/latest/>
118+
LSM303 Accelerometer and Magnetometer <https://circuitpython.readthedocs.io/projects/lsm303/en/latest/>
119+
LSM9DS0 Accelerometer, Magnetometer, Gyroscope and Temperature <https://circuitpython.readthedocs.io/projects/lsm9ds0/en/latest/>
120+
LSM9DS1 Accelerometer, Magnetometer, Gyroscope and Temperature <https://circuitpython.readthedocs.io/projects/lsm9ds1/en/latest/>
121+
MMA8451 3 axis accelerometer <https://circuitpython.readthedocs.io/projects/mma8451/en/latest/>
121122

122123
Environmental Sensors
123124
----------------------
@@ -128,20 +129,20 @@ equivalent carbon dioxide (``eco2`` / ``eCO2``), and total volatile organic comp
128129

129130
.. toctree::
130131

131-
B41A BME280 Temperature, Humidity and Pressure <https://circuitpython.readthedocs.io/projects/bme280/>
132-
BME680 Temperature, Humidity, Pressure and Gas <https://circuitpython.readthedocs.io/projects/bme680/>
133-
BMP280 Barometric Pressure and Altitude <https://circuitpython.readthedocs.io/projects/bmp280/>
134-
CCS811 Air Quality <https://circuitpython.readthedocs.io/projects/ccs811/>
135-
DHT Temperature and Humidity <https://circuitpython.readthedocs.io/projects/dht/>
136-
DS18x20 Temperature <https://circuitpython.readthedocs.io/projects/ds18x20/>
137-
MAX31865 Thermocouple Amplifier, Temperature <https://circuitpython.readthedocs.io/projects/max31865/>
138-
MAX31855 Thermocouple Amplifier, Temperature <https://circuitpython.readthedocs.io/projects/max31855/>
139-
MCP9808 Temperature <https://circuitpython.readthedocs.io/projects/mcp9808/>
140-
MPL3115A2 Barometric Pressure, Altitude and Temperature Sensor <https://circuitpython.readthedocs.io/projects/mpl3115a2/>
141-
SGP30 Air Quality <https://circuitpython.readthedocs.io/projects/sgp30/>
142-
SHT31-D Temperature and Humidity <https://circuitpython.readthedocs.io/projects/sht31d/>
143-
Si7021 Temperature and Humidity <https://circuitpython.readthedocs.io/projects/si7021/>
144-
Thermistor Temperature <https://circuitpython.readthedocs.io/projects/thermistor/>
132+
BME280 Temperature, Humidity and Pressure <https://circuitpython.readthedocs.io/projects/bme280/en/latest/>
133+
BME680 Temperature, Humidity, Pressure and Gas <https://circuitpython.readthedocs.io/projects/bme680/en/latest/>
134+
BMP280 Barometric Pressure and Altitude <https://circuitpython.readthedocs.io/projects/bmp280/en/latest/>
135+
CCS811 Air Quality <https://circuitpython.readthedocs.io/projects/ccs811/en/latest/>
136+
DHT Temperature and Humidity <https://circuitpython.readthedocs.io/projects/dht/en/latest/>
137+
DS18x20 Temperature <https://circuitpython.readthedocs.io/projects/ds18x20/en/latest/>
138+
MAX31865 Thermocouple Amplifier, Temperature <https://circuitpython.readthedocs.io/projects/max31865/en/latest/>
139+
MAX31855 Thermocouple Amplifier, Temperature <https://circuitpython.readthedocs.io/projects/max31855/en/latest/>
140+
MCP9808 Temperature <https://circuitpython.readthedocs.io/projects/mcp9808/en/latest/>
141+
MPL3115A2 Barometric Pressure, Altitude and Temperature Sensor <https://circuitpython.readthedocs.io/projects/mpl3115a2/en/latest/>
142+
SGP30 Air Quality <https://circuitpython.readthedocs.io/projects/sgp30/en/latest/>
143+
SHT31-D Temperature and Humidity <https://circuitpython.readthedocs.io/projects/sht31d/en/latest/>
144+
Si7021 Temperature and Humidity <https://circuitpython.readthedocs.io/projects/si7021/en/latest/>
145+
Thermistor Temperature <https://circuitpython.readthedocs.io/projects/thermistor/en/latest/>
145146

146147
Light Sensors
147148
---------------
@@ -151,12 +152,12 @@ These sensors detect light related attributes such as ``color``, ``light`` (unit
151152

152153
.. toctree::
153154

154-
APDS9960 Proximity, Light, RGB, and Gesture <https://circuitpython.readthedocs.io/projects/apds9960/>
155-
TCS34725 Color Sensor <https://circuitpython.readthedocs.io/projects/tcs34725/>
156-
TSL2561 Light Sensor <https://circuitpython.readthedocs.io/projects/tsl2561/>
157-
TSL2591 High Dynamic Range Light Sensor <https://circuitpython.readthedocs.io/projects/tsl2591/>
158-
VCNL4010 Proximity and Light <https://circuitpython.readthedocs.io/projects/vcnl4010/>
159-
VEML6070 UV Index <https://circuitpython.readthedocs.io/projects/veml6070/>
155+
APDS9960 Proximity, Light, RGB, and Gesture <https://circuitpython.readthedocs.io/projects/apds9960/en/latest/>
156+
TCS34725 Color Sensor <https://circuitpython.readthedocs.io/projects/tcs34725/en/latest/>
157+
TSL2561 Light Sensor <https://circuitpython.readthedocs.io/projects/tsl2561/en/latest/>
158+
TSL2591 High Dynamic Range Light Sensor <https://circuitpython.readthedocs.io/projects/tsl2591/en/latest/>
159+
VCNL4010 Proximity and Light <https://circuitpython.readthedocs.io/projects/vcnl4010/en/latest/>
160+
VEML6070 UV Index <https://circuitpython.readthedocs.io/projects/veml6070/en/latest/>
160161

161162
Distance Sensors
162163
------------------
@@ -165,8 +166,8 @@ These sensors measure the ``distance`` to another object and may also measure li
165166

166167
.. toctree::
167168

168-
VL6180x 5 - 100 mm <https://circuitpython.readthedocs.io/projects/vl6180x/>
169-
VL53L0x ~30 - 1000 mm <https://circuitpython.readthedocs.io/projects/vl53l0x/>
169+
VL6180x 5 - 100 mm <https://circuitpython.readthedocs.io/projects/vl6180x/en/latest/>
170+
VL53L0x ~30 - 1000 mm <https://circuitpython.readthedocs.io/projects/vl53l0x/en/latest/>
170171

171172
Radio
172173
--------
@@ -175,8 +176,8 @@ These chips communicate to other's over radio.
175176

176177
.. toctree::
177178

178-
RFM9x LoRa <https://circuitpython.readthedocs.io/projects/rfm9x/>
179-
RFM69 Packet Radio <https://circuitpython.readthedocs.io/projects/rfm69/>
179+
RFM9x LoRa <https://circuitpython.readthedocs.io/projects/rfm9x/en/latest/>
180+
RFM69 Packet Radio <https://circuitpython.readthedocs.io/projects/rfm69/en/latest/>
180181

181182
IO Expansion
182183
--------------
@@ -185,29 +186,29 @@ These provide functionality similar to `analogio`, `digitalio`, `pulseio`, and `
185186

186187
.. toctree::
187188

188-
Adafruit SeeSaw <https://circuitpython.readthedocs.io/projects/seesaw/>
189-
ADS1x15 Analog-to-Digital Converter <https://circuitpython.readthedocs.io/projects/ads1x15/>
190-
DS2413 OneWire GPIO Expander <https://circuitpython.readthedocs.io/projects/d2413/>
191-
FocalTech Capacitive Touch <https://circuitpython.readthedocs.io/projects/focaltouch/>
192-
MCP4725 Digital-to-Analog Converter <https://circuitpython.readthedocs.io/projects/mcp4725/>
193-
PCA9685 16 x 12-bit PWM Driver <https://circuitpython.readthedocs.io/projects/pca9685/>
194-
TLC5947 24 x 12-bit PWM Driver <https://circuitpython.readthedocs.io/projects/tlc5947/>
195-
TLC59711 12 x 16-bit PWM Driver <https://circuitpython.readthedocs.io/projects/tlc59711/>
196-
MCP4725 Capacitive Touch Sensor <https://circuitpython.readthedocs.io/projects/mpr121/>
189+
Adafruit SeeSaw <https://circuitpython.readthedocs.io/projects/seesaw/en/latest/>
190+
ADS1x15 Analog-to-Digital Converter <https://circuitpython.readthedocs.io/projects/ads1x15/en/latest/>
191+
DS2413 OneWire GPIO Expander <https://circuitpython.readthedocs.io/projects/ds2413/en/latest/>
192+
FocalTech Capacitive Touch <https://circuitpython.readthedocs.io/projects/focaltouch/en/latest/>
193+
MCP4725 Digital-to-Analog Converter <https://circuitpython.readthedocs.io/projects/mcp4725/en/latest/>
194+
PCA9685 16 x 12-bit PWM Driver <https://circuitpython.readthedocs.io/projects/pca9685/en/latest/>
195+
TLC5947 24 x 12-bit PWM Driver <https://circuitpython.readthedocs.io/projects/tlc5947/en/latest/>
196+
TLC59711 12 x 16-bit PWM Driver <https://circuitpython.readthedocs.io/projects/tlc59711/en/latest/>
197+
MPR121 Capacitive Touch Sensor <https://circuitpython.readthedocs.io/projects/mpr121/en/latest/>
197198

198199

199200
Miscellaneous
200201
----------------
201202

202203
.. toctree::
203204

204-
Si4713 Stereo FM Transmitter <https://circuitpython.readthedocs.io/projects/si4713/>
205-
AMG88xx Grid-Eye IR Camera <https://circuitpython.readthedocs.io/projects/amg88xx/>
206-
Trellis 4x4 Keypad <https://circuitpython.readthedocs.io/projects/trellis/>
207-
DRV2605 Haptic Motor Controller <https://circuitpython.readthedocs.io/projects/drv2605/>
208-
MAX9744 Audio Amplifier <https://circuitpython.readthedocs.io/projects/max9744/>
209-
Si5351 Clock Generator <https://circuitpython.readthedocs.io/projects/si5351/>
210-
Thermal Printer <https://circuitpython.readthedocs.io/projects/thermal_printer/>
211-
VC0706 TTL Camera <https://circuitpython.readthedocs.io/projects/vc0706/>
212-
INA219 High Side Current <https://circuitpython.readthedocs.io/projects/ina219/>
213-
Fingerprint <https://circuitpython.readthedocs.io/projects/fingerprint/>
205+
Si4713 Stereo FM Transmitter <https://circuitpython.readthedocs.io/projects/si4713/en/latest/>
206+
AMG88xx Grid-Eye IR Camera <https://circuitpython.readthedocs.io/projects/amg88xx/en/latest/>
207+
Trellis 4x4 Keypad <https://circuitpython.readthedocs.io/projects/trellis/en/latest/>
208+
DRV2605 Haptic Motor Controller <https://circuitpython.readthedocs.io/projects/drv2605/en/latest/>
209+
MAX9744 Audio Amplifier <https://circuitpython.readthedocs.io/projects/max9744/en/latest/>
210+
Si5351 Clock Generator <https://circuitpython.readthedocs.io/projects/si5351/en/latest/>
211+
Thermal Printer <https://circuitpython.readthedocs.io/projects/thermal_printer/en/latest/>
212+
VC0706 TTL Camera <https://circuitpython.readthedocs.io/projects/vc0706/en/latest/>
213+
INA219 High Side Current <https://circuitpython.readthedocs.io/projects/ina219/en/latest/>
214+
Fingerprint <https://circuitpython.readthedocs.io/projects/fingerprint/en/latest/>

0 commit comments

Comments
 (0)
0