remove wiki & update links to rtd

Infineon · Sep 23, 2024 · 510410e · 510410e
1 parent d4ed7fe
commit 510410e
Show file tree

Hide file tree

Showing 26 changed files with 16 additions and 10,394 deletions.
diff --git a/.github/workflows/publish_docs_to_wiki.yml b/.github/workflows/publish_docs_to_wiki.yml
diff --git a/Libraries.md b/Libraries.md
diff --git a/docs/arduino-deviations.rst b/docs/arduino-deviations.rst
@@ -274,12 +274,12 @@ function, or other case as described below.
     * - XMC4400 Platform 2Go
       - External hard wired pins
       - | For 3V3 boards set I2C pins to tristate or open drain to use
-        | For 5V boards see Wiki board page on track cuts to enable A4 and A5 to work
+        | For 5V boards refer to [this section](https://xmc-arduino.readthedocs.io/en/latest/hw-platforms.html#connected-i2s-and-analog-pins) on track cuts to enable A4 and A5 to work
         | Level shifter on the 5V board could interfere with tristate/open drain setting
     * - XMC4700 Relax Kit (and variants)
       - External hard wired pins
       - | For 3V3 boards set I2C pins to tristate or open drain to use
-        | For 5V boards see Wiki board page on track cuts to enable A4 and A5 to work
+        | For 5V boards see [this section](https://xmc-arduino.readthedocs.io/en/latest/hw-platforms.html#connected-i2s-and-analog-pins) board page on track cuts to enable A4 and A5 to work
         | Level shifter on the 5V board could interfere with tristate/open drain setting
 
 

diff --git a/libraries/DMA/Readme.MD b/libraries/DMA/Readme.MD
@@ -1,6 +1,6 @@
-# DMA library for XMC
+# DMA Library for XMC
 
-This library helps to manage DMA for XMC microcontrollers 
+This library helps to manage DMA for XMC microcontrollers.
 
 ## Additional Information
-See also our [Wiki](https://github.com/Infineon/XMC-for-Arduino/wiki/Core-Libraries)
+See also our [documentation](https://xmc-arduino.readthedocs.io/en/latest/builtin-libraries.html).
diff --git a/libraries/DeviceControlXMC/Readme.MD b/libraries/DeviceControlXMC/Readme.MD
@@ -1,6 +1,6 @@
 # DeviceControlXMC library for XMC
 
-This library includes the basic device control examples of the XMC which mesaures temperature, memory and sleep mode measurement
+This library includes the basic device control examples of the XMC which mesaures temperature, memory and sleep mode measurement.
 
 ## Additional Information
-See also our [Wiki](https://github.com/Infineon/XMC-for-Arduino/wiki/Core-Libraries)
+See also our [documentation](https://xmc-arduino.readthedocs.io/en/latest/builtin-libraries.html).
diff --git a/libraries/I2S/README.md b/libraries/I2S/README.md
@@ -72,7 +72,7 @@ However, if you are using an XMC4000 board such as a XMC4700 Relax Kit, you shou
 Sometimes, it also makes sense to adjust the data delay, which is the delay between a changing WA/LRCL edge and the start of a sample depending on the microphone of your choice. Please be aware that there are different `I2S.begin()` functions which allow to set the parameters very precisely. Have a look in the I2S.h file for more information.
 
 ## Additional Information
-See also our [Wiki](https://github.com/Infineon/XMC-for-Arduino/wiki/Core-Libraries) and doxygen-generated [documentation page](https://github.com/Infineon/InfineonDoxyGenerator).
+See also our [documentation](https://xmc-arduino.readthedocs.io/en/latest/builtin-libraries.html).
 
 ## Authors
 Manuel Hollfelder 

diff --git a/libraries/OneWire/Readme.MD b/libraries/OneWire/Readme.MD
@@ -1,7 +1,6 @@
-# OneWire library for XMC
+# OneWire Library for XMC
 
 OneWire library lets you access 1-wire devices.
 
 ## Additional Information
-
-See also our [Wiki](https://github.com/Infineon/XMC-for-Arduino/wiki/Core-Libraries)
+See also our [documentation](https://xmc-arduino.readthedocs.io/en/latest/builtin-libraries.html).
diff --git a/libraries/RTC/Readme.MD b/libraries/RTC/Readme.MD
@@ -1,6 +1,6 @@
 # RTC Library for XMC
 
-This is the real time clock library that is supported by XMC4700
+This is the real time clock library that is supported by XMC4700.
 
 ## Additional Information
-See also our [Wiki](https://github.com/Infineon/XMC-for-Arduino/wiki/Core-Libraries)
+See also our [documentation](https://xmc-arduino.readthedocs.io/en/latest/builtin-libraries.html).
diff --git a/libraries/SPI/Readme.MD b/libraries/SPI/Readme.MD
@@ -3,4 +3,4 @@
 This library supports the Serial peripheral interaface communication protocol for the XMC.
 
 ## Additional Information
-See also our [Wiki](https://github.com/Infineon/XMC-for-Arduino/wiki/Core-Libraries)
+See also our [documentation](https://xmc-arduino.readthedocs.io/en/latest/builtin-libraries.html).
diff --git a/libraries/Wire/Readme.MD b/libraries/Wire/Readme.MD
@@ -2,4 +2,4 @@
 This library allows you to communicate with I2C/TWI devices.
 
 ## Additional Information
-See also our [Wiki](https://github.com/Infineon/XMC-for-Arduino/wiki/Core-Libraries)
+See also our [documentation](https://xmc-arduino.readthedocs.io/en/latest/builtin-libraries.html).
diff --git a/package/package_infineon_index.template.json b/package/package_infineon_index.template.json
@@ -6,7 +6,7 @@
             "websiteURL": "https://www.infineon.com",
             "email": "",
             "help": {
-                "online": "https://github.com/Infineon/XMC-for-Arduino/wiki"
+                "online": "https://xmc-arduino.readthedocs.io/en/latest/index.html"
             },
             "platforms": [
                 {
@@ -19,7 +19,7 @@
                     "checksum": "",
                     "size": "",
                     "help": {
-                        "online": "https://github.com/Infineon/XMC-for-Arduino/wiki"
+                        "online": "https://xmc-arduino.readthedocs.io/en/latest/index.html"
                     },
                     "boards": [
                         {

diff --git a/resources/readme.md b/resources/readme.md