diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 2231cc290..710f8b0ff 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -42,8 +42,6 @@ jobs: run: make build_doxygen_adoc - name: Build documentation run: make -j 2 - - name: Run tests - run: ./tests/run_documentation_tests.sh - name: Deploy to Mythic Beasts if: ${{ github.ref == 'refs/heads/master' }} uses: ./.github/actions/deploy-action diff --git a/documentation/asciidoc/accessories/ai-kit/images/ai-kit.jpg b/documentation/asciidoc/accessories/ai-kit/images/ai-kit.jpg index 9ea0c1624..d519b0ff4 100644 Binary files a/documentation/asciidoc/accessories/ai-kit/images/ai-kit.jpg and b/documentation/asciidoc/accessories/ai-kit/images/ai-kit.jpg differ diff --git a/documentation/asciidoc/accessories/audio/getting_started.adoc b/documentation/asciidoc/accessories/audio/getting_started.adoc index f08328882..7efbd7f9a 100644 --- a/documentation/asciidoc/accessories/audio/getting_started.adoc +++ b/documentation/asciidoc/accessories/audio/getting_started.adoc @@ -130,7 +130,7 @@ Press *Ctrl X*, then *Y*, then *Enter* to save, then reboot your device with `su The final step is to ensure that everything is operating as expected. Press the button and release it when you hear the burp. The recording will now begin for a period of five seconds. Once you have released the button, press it briefly again to hear the recording. Repeat this process as many times as you wish, and your sounds will be played at random. You can delete all recordings by pressing and holding the button, keeping the button pressed during the first burp and recording process, and releasing it after at least 20 seconds, at which point you will hear another burp sound confirming that the recordings have been deleted. -video::BjXERzu8nS0[youtube] +video::BjXERzu8nS0[youtube,width=80%,height=400px] === Next steps diff --git a/documentation/asciidoc/accessories/audio/images/Chatter_Box.jpg b/documentation/asciidoc/accessories/audio/images/Chatter_Box.jpg index 7d7bfb0e0..b09c69521 100644 Binary files a/documentation/asciidoc/accessories/audio/images/Chatter_Box.jpg and b/documentation/asciidoc/accessories/audio/images/Chatter_Box.jpg differ diff --git a/documentation/asciidoc/accessories/audio/images/Chatterbox_Labels.png b/documentation/asciidoc/accessories/audio/images/Chatterbox_Labels.png index 7f54c5b97..379df111f 100644 Binary files a/documentation/asciidoc/accessories/audio/images/Chatterbox_Labels.png and b/documentation/asciidoc/accessories/audio/images/Chatterbox_Labels.png differ diff --git a/documentation/asciidoc/accessories/audio/images/Codec_Zero_Board_Diagram.png b/documentation/asciidoc/accessories/audio/images/Codec_Zero_Board_Diagram.png index 441453078..4e02bdedb 100644 Binary files a/documentation/asciidoc/accessories/audio/images/Codec_Zero_Board_Diagram.png and b/documentation/asciidoc/accessories/audio/images/Codec_Zero_Board_Diagram.png differ diff --git a/documentation/asciidoc/accessories/audio/images/DAC+_Board_Diagram.png b/documentation/asciidoc/accessories/audio/images/DAC+_Board_Diagram.png index afa6ed1d6..7a68f02c4 100644 Binary files a/documentation/asciidoc/accessories/audio/images/DAC+_Board_Diagram.png and b/documentation/asciidoc/accessories/audio/images/DAC+_Board_Diagram.png differ diff --git a/documentation/asciidoc/accessories/audio/images/DAC_Pro_Board_Diagram.png b/documentation/asciidoc/accessories/audio/images/DAC_Pro_Board_Diagram.png index 9cab3ed31..033ed5e1b 100644 Binary files a/documentation/asciidoc/accessories/audio/images/DAC_Pro_Board_Diagram.png and b/documentation/asciidoc/accessories/audio/images/DAC_Pro_Board_Diagram.png differ diff --git a/documentation/asciidoc/accessories/audio/images/DigiAMP+_Board_Diagram.png b/documentation/asciidoc/accessories/audio/images/DigiAMP+_Board_Diagram.png index 7c6411100..e4f2b336b 100644 Binary files a/documentation/asciidoc/accessories/audio/images/DigiAMP+_Board_Diagram.png and b/documentation/asciidoc/accessories/audio/images/DigiAMP+_Board_Diagram.png differ diff --git a/documentation/asciidoc/accessories/audio/images/dac_plus.png b/documentation/asciidoc/accessories/audio/images/dac_plus.png index 6c3ad6455..61154d683 100644 Binary files a/documentation/asciidoc/accessories/audio/images/dac_plus.png and b/documentation/asciidoc/accessories/audio/images/dac_plus.png differ diff --git a/documentation/asciidoc/accessories/audio/images/optional_xlr_board.jpg b/documentation/asciidoc/accessories/audio/images/optional_xlr_board.jpg index 7e6e85d4e..526b1c2d5 100644 Binary files a/documentation/asciidoc/accessories/audio/images/optional_xlr_board.jpg and b/documentation/asciidoc/accessories/audio/images/optional_xlr_board.jpg differ diff --git a/documentation/asciidoc/accessories/audio/images/wiring.jpg b/documentation/asciidoc/accessories/audio/images/wiring.jpg index 5481ce90c..3a22c834b 100644 Binary files a/documentation/asciidoc/accessories/audio/images/wiring.jpg and b/documentation/asciidoc/accessories/audio/images/wiring.jpg differ diff --git a/documentation/asciidoc/accessories/audio/images/write_protect_tabs.jpg b/documentation/asciidoc/accessories/audio/images/write_protect_tabs.jpg index 5da7d0723..91e2f65f1 100644 Binary files a/documentation/asciidoc/accessories/audio/images/write_protect_tabs.jpg and b/documentation/asciidoc/accessories/audio/images/write_protect_tabs.jpg differ diff --git a/documentation/asciidoc/accessories/build-hat/images/blinking-light.gif b/documentation/asciidoc/accessories/build-hat/images/blinking-light.gif deleted file mode 100644 index 401912503..000000000 Binary files a/documentation/asciidoc/accessories/build-hat/images/blinking-light.gif and /dev/null differ diff --git a/documentation/asciidoc/accessories/build-hat/images/blinking-light.webm b/documentation/asciidoc/accessories/build-hat/images/blinking-light.webm new file mode 100644 index 000000000..12ecb8a3b Binary files /dev/null and b/documentation/asciidoc/accessories/build-hat/images/blinking-light.webm differ diff --git a/documentation/asciidoc/accessories/build-hat/images/connect-motor.gif b/documentation/asciidoc/accessories/build-hat/images/connect-motor.gif deleted file mode 100644 index 197a87cc8..000000000 Binary files a/documentation/asciidoc/accessories/build-hat/images/connect-motor.gif and /dev/null differ diff --git a/documentation/asciidoc/accessories/build-hat/images/connect-motor.webm b/documentation/asciidoc/accessories/build-hat/images/connect-motor.webm new file mode 100644 index 000000000..70da88129 Binary files /dev/null and b/documentation/asciidoc/accessories/build-hat/images/connect-motor.webm differ diff --git a/documentation/asciidoc/accessories/build-hat/images/fitting-build-hat.gif b/documentation/asciidoc/accessories/build-hat/images/fitting-build-hat.gif deleted file mode 100644 index f1cac0bf3..000000000 Binary files a/documentation/asciidoc/accessories/build-hat/images/fitting-build-hat.gif and /dev/null differ diff --git a/documentation/asciidoc/accessories/build-hat/images/fitting-build-hat.webm b/documentation/asciidoc/accessories/build-hat/images/fitting-build-hat.webm new file mode 100644 index 000000000..8d64b6817 Binary files /dev/null and b/documentation/asciidoc/accessories/build-hat/images/fitting-build-hat.webm differ diff --git a/documentation/asciidoc/accessories/build-hat/images/powering-build-hat.gif b/documentation/asciidoc/accessories/build-hat/images/powering-build-hat.gif deleted file mode 100644 index e065f39b2..000000000 Binary files a/documentation/asciidoc/accessories/build-hat/images/powering-build-hat.gif and /dev/null differ diff --git a/documentation/asciidoc/accessories/build-hat/images/powering-build-hat.webm b/documentation/asciidoc/accessories/build-hat/images/powering-build-hat.webm new file mode 100644 index 000000000..e358683f9 Binary files /dev/null and b/documentation/asciidoc/accessories/build-hat/images/powering-build-hat.webm differ diff --git a/documentation/asciidoc/accessories/build-hat/images/tall-headers.png b/documentation/asciidoc/accessories/build-hat/images/tall-headers.png index 58eff7352..cf89aa68e 100644 Binary files a/documentation/asciidoc/accessories/build-hat/images/tall-headers.png and b/documentation/asciidoc/accessories/build-hat/images/tall-headers.png differ diff --git a/documentation/asciidoc/accessories/build-hat/images/turning-motor.gif b/documentation/asciidoc/accessories/build-hat/images/turning-motor.gif deleted file mode 100644 index 71b7b0c06..000000000 Binary files a/documentation/asciidoc/accessories/build-hat/images/turning-motor.gif and /dev/null differ diff --git a/documentation/asciidoc/accessories/build-hat/images/turning-motor.webm b/documentation/asciidoc/accessories/build-hat/images/turning-motor.webm new file mode 100644 index 000000000..334b43eae Binary files /dev/null and b/documentation/asciidoc/accessories/build-hat/images/turning-motor.webm differ diff --git a/documentation/asciidoc/accessories/build-hat/preparing-build-hat.adoc b/documentation/asciidoc/accessories/build-hat/preparing-build-hat.adoc index 86c04dacc..0e19d8bda 100644 --- a/documentation/asciidoc/accessories/build-hat/preparing-build-hat.adoc +++ b/documentation/asciidoc/accessories/build-hat/preparing-build-hat.adoc @@ -4,7 +4,7 @@ NOTE: Before starting to work with your Raspberry Pi Build HAT you should xref:. Attach 9mm spacers to the bottom of the board. Seat the Raspberry Pi Build HAT onto your Raspberry Pi. Make sure you put it on the right way up. Unlike other HATs, all the components are on the bottom, leaving room for a breadboard or LEGO® elements on top. -image::images/fitting-build-hat.gif[width="80%"] +video::images/fitting-build-hat.webm[width="80%"] === Access the GPIO Pins @@ -68,7 +68,7 @@ Connect an external power supply — the https://raspberrypi.com/products/build- The Build HAT cannot power Keyboard-series devices, since they do not support power supply over the GPIO headers. ==== -image::images/powering-build-hat.gif[width="80%"] +video::images/powering-build-hat.webm[width="80%"] [NOTE] ==== diff --git a/documentation/asciidoc/accessories/build-hat/py-motors.adoc b/documentation/asciidoc/accessories/build-hat/py-motors.adoc index 72f50d84e..7cf498f67 100644 --- a/documentation/asciidoc/accessories/build-hat/py-motors.adoc +++ b/documentation/asciidoc/accessories/build-hat/py-motors.adoc @@ -6,7 +6,7 @@ There are xref:build-hat.adoc#device-compatibility[a number of motors] that work Connect a motor to port A on the Build HAT. The LPF2 connectors need to be inserted the correct way up. If the connector doesn't slide in easily, rotate by 180 degrees and try again. -image::images/connect-motor.gif[width="80%"] +video::images/connect-motor.webm[width="80%"] ==== Work with Motors @@ -24,11 +24,11 @@ motor_a.run_for_seconds(5) Run the program by clicking the play/run button. If this is the first time you're running a Build HAT program since the Raspberry Pi has booted, there will be a few seconds pause while the firmware is copied across to the board. You should see the red LED extinguish and the green LED illuminate. Subsequent executions of a Python program will not require this pause. -image::images/blinking-light.gif[width="80%"] +video::images/blinking-light.webm[width="80%"] Your motor should turn clockwise for 5 seconds. -image::images/turning-motor.gif[width="80%"] +video::images/turning-motor.webm[width="80%"] Change the final line of your program and re-run. diff --git a/documentation/asciidoc/accessories/camera/camera_hardware.adoc b/documentation/asciidoc/accessories/camera/camera_hardware.adoc index d8cdb35b9..2c62ce3d6 100644 --- a/documentation/asciidoc/accessories/camera/camera_hardware.adoc +++ b/documentation/asciidoc/accessories/camera/camera_hardware.adoc @@ -47,7 +47,7 @@ The flex cable inserts into the connector labelled CAMERA on the Raspberry Pi, w We have created a video to illustrate the process of connecting the camera. The following video shows how to connect the original camera on the original Raspberry Pi 1. The principle is the same for all Raspberry Pi boards with a camera connector, though the Raspberry Pi 5 and all Raspberry Pi Zero models require a https://www.raspberrypi.com/products/camera-cable/[different camera cable]. -video::GImeVqHQzsE[youtube] +video::GImeVqHQzsE[youtube,width=80%,height=400px] Depending on the model, the camera may come with a small piece of translucent blue plastic film covering the lens. This is only present to protect the lens while it is being mailed to you, and needs to be removed by gently peeling it off. diff --git a/documentation/asciidoc/accessories/camera/images/FILTER_OFF.jpg b/documentation/asciidoc/accessories/camera/images/FILTER_OFF.jpg index c9f4778b9..918eb217f 100644 Binary files a/documentation/asciidoc/accessories/camera/images/FILTER_OFF.jpg and b/documentation/asciidoc/accessories/camera/images/FILTER_OFF.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/FILTER_ON.jpg b/documentation/asciidoc/accessories/camera/images/FILTER_ON.jpg index 3c728b056..47abc24c7 100644 Binary files a/documentation/asciidoc/accessories/camera/images/FILTER_ON.jpg and b/documentation/asciidoc/accessories/camera/images/FILTER_ON.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/FLATLAY.jpg b/documentation/asciidoc/accessories/camera/images/FLATLAY.jpg index ef6512792..6fad88e33 100644 Binary files a/documentation/asciidoc/accessories/camera/images/FLATLAY.jpg and b/documentation/asciidoc/accessories/camera/images/FLATLAY.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/REMOVE_FILTER.jpg b/documentation/asciidoc/accessories/camera/images/REMOVE_FILTER.jpg index bf3d39b58..845fda298 100644 Binary files a/documentation/asciidoc/accessories/camera/images/REMOVE_FILTER.jpg and b/documentation/asciidoc/accessories/camera/images/REMOVE_FILTER.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/SCREW_REMOVED.jpg b/documentation/asciidoc/accessories/camera/images/SCREW_REMOVED.jpg index 6eae6044c..02cb97774 100644 Binary files a/documentation/asciidoc/accessories/camera/images/SCREW_REMOVED.jpg and b/documentation/asciidoc/accessories/camera/images/SCREW_REMOVED.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/SOLVENT.jpg b/documentation/asciidoc/accessories/camera/images/SOLVENT.jpg index d84a386f2..e7c4e965a 100644 Binary files a/documentation/asciidoc/accessories/camera/images/SOLVENT.jpg and b/documentation/asciidoc/accessories/camera/images/SOLVENT.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/m12-lens.jpg b/documentation/asciidoc/accessories/camera/images/m12-lens.jpg index dae4e2599..875f0297a 100644 Binary files a/documentation/asciidoc/accessories/camera/images/m12-lens.jpg and b/documentation/asciidoc/accessories/camera/images/m12-lens.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/resistor.jpg b/documentation/asciidoc/accessories/camera/images/resistor.jpg index 21a5451bc..7d9fc1077 100644 Binary files a/documentation/asciidoc/accessories/camera/images/resistor.jpg and b/documentation/asciidoc/accessories/camera/images/resistor.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_clear_filter.jpg b/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_clear_filter.jpg index 00daf6b07..dc401f9ad 100644 Binary files a/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_clear_filter.jpg and b/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_clear_filter.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_gasket.jpg b/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_gasket.jpg index b4cd564a4..572ca3167 100644 Binary files a/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_gasket.jpg and b/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_gasket.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_ir_filter.jpg b/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_ir_filter.jpg index 8b786511b..ee09e5b4c 100644 Binary files a/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_ir_filter.jpg and b/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_ir_filter.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_sensor.jpg b/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_sensor.jpg index d9792c2f3..40bb170bb 100644 Binary files a/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_sensor.jpg and b/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_sensor.jpg differ diff --git a/documentation/asciidoc/accessories/display/images/display-rotation.png b/documentation/asciidoc/accessories/display/images/display-rotation.png index 81143b3ad..86eb3a10b 100755 Binary files a/documentation/asciidoc/accessories/display/images/display-rotation.png and b/documentation/asciidoc/accessories/display/images/display-rotation.png differ diff --git a/documentation/asciidoc/accessories/display/images/display.png b/documentation/asciidoc/accessories/display/images/display.png index 2e07d6ea5..dd7ae3361 100644 Binary files a/documentation/asciidoc/accessories/display/images/display.png and b/documentation/asciidoc/accessories/display/images/display.png differ diff --git a/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus.jpg b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus.jpg index 757a4fe46..30a05a30b 100644 Binary files a/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus.jpg and b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus.jpg differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_1.jpeg b/documentation/asciidoc/accessories/monitor/images/repair_1.jpeg deleted file mode 100644 index dd6c31812..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_1.jpeg and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_10.png b/documentation/asciidoc/accessories/monitor/images/repair_10.png deleted file mode 100644 index ff4643235..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_10.png and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_11.png b/documentation/asciidoc/accessories/monitor/images/repair_11.png deleted file mode 100644 index 08e9e995e..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_11.png and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_12.png b/documentation/asciidoc/accessories/monitor/images/repair_12.png deleted file mode 100644 index 5a29bc938..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_12.png and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_13.png b/documentation/asciidoc/accessories/monitor/images/repair_13.png deleted file mode 100644 index 1ce5c4f14..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_13.png and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_14.jpeg b/documentation/asciidoc/accessories/monitor/images/repair_14.jpeg deleted file mode 100644 index 614fc7e2a..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_14.jpeg and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_15.jpeg b/documentation/asciidoc/accessories/monitor/images/repair_15.jpeg deleted file mode 100644 index de08d27e5..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_15.jpeg and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_16.jpeg b/documentation/asciidoc/accessories/monitor/images/repair_16.jpeg deleted file mode 100644 index 3085831cd..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_16.jpeg and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_17.jpeg b/documentation/asciidoc/accessories/monitor/images/repair_17.jpeg deleted file mode 100644 index f819226a7..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_17.jpeg and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_19.jpeg b/documentation/asciidoc/accessories/monitor/images/repair_19.jpeg deleted file mode 100644 index 697ed206f..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_19.jpeg and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_2.jpeg b/documentation/asciidoc/accessories/monitor/images/repair_2.jpeg deleted file mode 100644 index e856e3b06..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_2.jpeg and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_20.jpeg b/documentation/asciidoc/accessories/monitor/images/repair_20.jpeg deleted file mode 100644 index 69f97d64a..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_20.jpeg and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_21.jpeg b/documentation/asciidoc/accessories/monitor/images/repair_21.jpeg deleted file mode 100644 index 0acb14feb..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_21.jpeg and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_22.png b/documentation/asciidoc/accessories/monitor/images/repair_22.png deleted file mode 100644 index 99f0cdc17..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_22.png and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_23.png b/documentation/asciidoc/accessories/monitor/images/repair_23.png deleted file mode 100644 index de8d7ad39..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_23.png and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_25.jpeg b/documentation/asciidoc/accessories/monitor/images/repair_25.jpeg deleted file mode 100644 index 5070f0496..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_25.jpeg and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_3.jpeg b/documentation/asciidoc/accessories/monitor/images/repair_3.jpeg deleted file mode 100644 index d3a9b8e58..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_3.jpeg and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_4.jpeg b/documentation/asciidoc/accessories/monitor/images/repair_4.jpeg deleted file mode 100644 index 7515cb6bb..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_4.jpeg and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_5.jpeg b/documentation/asciidoc/accessories/monitor/images/repair_5.jpeg deleted file mode 100644 index 6791b6a49..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_5.jpeg and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_6.png b/documentation/asciidoc/accessories/monitor/images/repair_6.png deleted file mode 100644 index a9a4f359d..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_6.png and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_7.png b/documentation/asciidoc/accessories/monitor/images/repair_7.png deleted file mode 100644 index 80300d30d..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_7.png and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_8.png b/documentation/asciidoc/accessories/monitor/images/repair_8.png deleted file mode 100644 index f5a48b8d2..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_8.png and /dev/null differ diff --git a/documentation/asciidoc/accessories/monitor/images/repair_9.png b/documentation/asciidoc/accessories/monitor/images/repair_9.png deleted file mode 100644 index 8bf2ed7f4..000000000 Binary files a/documentation/asciidoc/accessories/monitor/images/repair_9.png and /dev/null differ diff --git a/documentation/asciidoc/accessories/sense-hat/images/Sense-HAT.jpg b/documentation/asciidoc/accessories/sense-hat/images/Sense-HAT.jpg index ef74aa37a..e1eebd815 100644 Binary files a/documentation/asciidoc/accessories/sense-hat/images/Sense-HAT.jpg and b/documentation/asciidoc/accessories/sense-hat/images/Sense-HAT.jpg differ diff --git a/documentation/asciidoc/computers/ai/getting-started.adoc b/documentation/asciidoc/computers/ai/getting-started.adoc index b94983915..0ec7ffcca 100644 --- a/documentation/asciidoc/computers/ai/getting-started.adoc +++ b/documentation/asciidoc/computers/ai/getting-started.adoc @@ -188,7 +188,7 @@ To install version 4.17 of Hailo's neural network tooling, run the following com + [source,console] ---- -$ sudo apt install hailo-tappas-core-3.28.2 hailort=4.17.0 hailo-dkms=4.17.0-1 +$ sudo apt install hailo-tappas-core=3.28.2 hailort=4.17.0 hailo-dkms=4.17.0-1 ---- + [source,console] diff --git a/documentation/asciidoc/computers/camera/images/cam.jpg b/documentation/asciidoc/computers/camera/images/cam.jpg deleted file mode 100644 index 38963884d..000000000 Binary files a/documentation/asciidoc/computers/camera/images/cam.jpg and /dev/null differ diff --git a/documentation/asciidoc/computers/camera/images/cam2.jpg b/documentation/asciidoc/computers/camera/images/cam2.jpg deleted file mode 100644 index 01d39ca9c..000000000 Binary files a/documentation/asciidoc/computers/camera/images/cam2.jpg and /dev/null differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm4.jpg b/documentation/asciidoc/computers/compute-module/images/cm4.jpg index 0a9dd7340..a60f5b73b 100644 Binary files a/documentation/asciidoc/computers/compute-module/images/cm4.jpg and b/documentation/asciidoc/computers/compute-module/images/cm4.jpg differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm4s.jpg b/documentation/asciidoc/computers/compute-module/images/cm4s.jpg index eff4a68ee..7119617d8 100644 Binary files a/documentation/asciidoc/computers/compute-module/images/cm4s.jpg and b/documentation/asciidoc/computers/compute-module/images/cm4s.jpg differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm5io-case-front.png b/documentation/asciidoc/computers/compute-module/images/cm5io-case-front.png index dd41c6d3d..055875438 100644 Binary files a/documentation/asciidoc/computers/compute-module/images/cm5io-case-front.png and b/documentation/asciidoc/computers/compute-module/images/cm5io-case-front.png differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm5io-case.png b/documentation/asciidoc/computers/compute-module/images/cm5io-case.png index 73a04c27b..074e802b6 100644 Binary files a/documentation/asciidoc/computers/compute-module/images/cm5io-case.png and b/documentation/asciidoc/computers/compute-module/images/cm5io-case.png differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm5io.png b/documentation/asciidoc/computers/compute-module/images/cm5io.png index 345cd7774..382ae0b2c 100644 Binary files a/documentation/asciidoc/computers/compute-module/images/cm5io.png and b/documentation/asciidoc/computers/compute-module/images/cm5io.png differ diff --git a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-all.png b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-all.png index 1619e20df..03c0124f2 100644 Binary files a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-all.png and b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-all.png differ diff --git a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-hdmi.png b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-hdmi.png index e5dd0d949..62ebf3713 100644 Binary files a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-hdmi.png and b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-hdmi.png differ diff --git a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-key.png b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-key.png index 919b922c0..4f277513e 100644 Binary files a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-key.png and b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-key.png differ diff --git a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-mouse.png b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-mouse.png index 4a9c8e7e6..a00b9e869 100644 Binary files a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-mouse.png and b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-mouse.png differ diff --git a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-net.png b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-net.png index 7000de9cd..4cf13f939 100644 Binary files a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-net.png and b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-net.png differ diff --git a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-power.png b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-power.png index 69d133ab9..44e4b032a 100644 Binary files a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-power.png and b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-power.png differ diff --git a/documentation/asciidoc/computers/getting-started/images/peripherals/sd-card.png b/documentation/asciidoc/computers/getting-started/images/peripherals/sd-card.png index 5aeb831e7..9ea290c67 100644 Binary files a/documentation/asciidoc/computers/getting-started/images/peripherals/sd-card.png and b/documentation/asciidoc/computers/getting-started/images/peripherals/sd-card.png differ diff --git a/documentation/asciidoc/computers/getting-started/install.adoc b/documentation/asciidoc/computers/getting-started/install.adoc index e2eb01e4a..c533e842b 100644 --- a/documentation/asciidoc/computers/getting-started/install.adoc +++ b/documentation/asciidoc/computers/getting-started/install.adoc @@ -24,7 +24,7 @@ If you have no other computer to write an image to a boot device, you may be abl === Install using Imager //// -TODO: Update this video for the new Imager look & flow (video::ntaXWS8Lk34[youtube]) +TODO: Update this video for the new Imager look & flow (video::ntaXWS8Lk34[youtube,width=80%,height=400px]) //// You can install Imager in the following ways: @@ -127,7 +127,7 @@ Network Install enables a Raspberry Pi to install an operating system on a stora Network Install only runs on Flagship models since Raspberry Pi 4B and Keyboard models. If your Raspberry Pi runs an older bootloader, you may need to xref:raspberry-pi.adoc#bootloader_update_stable[update the bootloader] to use Network Install. //// -TODO: Update this video for the new Imager look & flow video::b1SYVpM9lto[youtube] +TODO: Update this video for the new Imager look & flow video::b1SYVpM9lto[youtube,width=80%,height=400px] //// Network Install requires the following: diff --git a/documentation/asciidoc/computers/getting-started/setting-up.adoc b/documentation/asciidoc/computers/getting-started/setting-up.adoc index a1516a991..81765bf4c 100644 --- a/documentation/asciidoc/computers/getting-started/setting-up.adoc +++ b/documentation/asciidoc/computers/getting-started/setting-up.adoc @@ -1,7 +1,7 @@ [[setting-up-your-raspberry-pi]] == Getting started with your Raspberry Pi -video::CQtliTJ41ZE[youtube] +video::CQtliTJ41ZE[youtube,width=80%,height=400px] To get started with your Raspberry Pi, you'll need the following: diff --git a/documentation/asciidoc/computers/raspberry-pi/images/500.png b/documentation/asciidoc/computers/raspberry-pi/images/500.png index 5e44bbb04..d4965dc0b 100644 Binary files a/documentation/asciidoc/computers/raspberry-pi/images/500.png and b/documentation/asciidoc/computers/raspberry-pi/images/500.png differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/compute-module-4.jpg b/documentation/asciidoc/computers/raspberry-pi/images/compute-module-4.jpg index 0a9dd7340..74141b492 100644 Binary files a/documentation/asciidoc/computers/raspberry-pi/images/compute-module-4.jpg and b/documentation/asciidoc/computers/raspberry-pi/images/compute-module-4.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/compute-module-4s.jpg b/documentation/asciidoc/computers/raspberry-pi/images/compute-module-4s.jpg index eff4a68ee..7119617d8 100644 Binary files a/documentation/asciidoc/computers/raspberry-pi/images/compute-module-4s.jpg and b/documentation/asciidoc/computers/raspberry-pi/images/compute-module-4s.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/compute-module-5.png b/documentation/asciidoc/computers/raspberry-pi/images/compute-module-5.png index 8e6dab57d..70140e593 100644 Binary files a/documentation/asciidoc/computers/raspberry-pi/images/compute-module-5.png and b/documentation/asciidoc/computers/raspberry-pi/images/compute-module-5.png differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/j5.png b/documentation/asciidoc/computers/raspberry-pi/images/j5.png index ca70ca3e1..1de24e571 100644 Binary files a/documentation/asciidoc/computers/raspberry-pi/images/j5.png and b/documentation/asciidoc/computers/raspberry-pi/images/j5.png differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/zero-2-wh.png b/documentation/asciidoc/computers/raspberry-pi/images/zero-2-wh.png index 96e85c626..f87157e22 100644 Binary files a/documentation/asciidoc/computers/raspberry-pi/images/zero-2-wh.png and b/documentation/asciidoc/computers/raspberry-pi/images/zero-2-wh.png differ diff --git a/documentation/asciidoc/computers/remote-access/images/network-tooltip.png b/documentation/asciidoc/computers/remote-access/images/network-tooltip.png index e3c05343d..86351ee3b 100644 Binary files a/documentation/asciidoc/computers/remote-access/images/network-tooltip.png and b/documentation/asciidoc/computers/remote-access/images/network-tooltip.png differ diff --git a/documentation/asciidoc/computers/remote-access/images/raspberry-pi-configuration.png b/documentation/asciidoc/computers/remote-access/images/raspberry-pi-configuration.png index d4063814c..2c99724c1 100644 Binary files a/documentation/asciidoc/computers/remote-access/images/raspberry-pi-configuration.png and b/documentation/asciidoc/computers/remote-access/images/raspberry-pi-configuration.png differ diff --git a/documentation/asciidoc/computers/remote-access/images/vnc-enable.png b/documentation/asciidoc/computers/remote-access/images/vnc-enable.png index 63b07d841..4c81b61ea 100644 Binary files a/documentation/asciidoc/computers/remote-access/images/vnc-enable.png and b/documentation/asciidoc/computers/remote-access/images/vnc-enable.png differ diff --git a/documentation/asciidoc/computers/remote-access/images/vnc-tigervnc-desktop.png b/documentation/asciidoc/computers/remote-access/images/vnc-tigervnc-desktop.png index 96eeff4d0..e8420b865 100644 Binary files a/documentation/asciidoc/computers/remote-access/images/vnc-tigervnc-desktop.png and b/documentation/asciidoc/computers/remote-access/images/vnc-tigervnc-desktop.png differ diff --git a/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED-640x360-v2.gif b/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED-640x360-v2.gif deleted file mode 100644 index ac47dd4c1..000000000 Binary files a/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED-640x360-v2.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED-640x360.gif b/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED-640x360.gif deleted file mode 100644 index a2a1042e6..000000000 Binary files a/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED-640x360.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED-FINAL.gif b/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED-FINAL.gif deleted file mode 100644 index cf249e8ef..000000000 Binary files a/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED-FINAL.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED.webm b/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED.webm new file mode 100644 index 000000000..5d1c3df81 Binary files /dev/null and b/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED.webm differ diff --git a/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World-640x360-v2.gif b/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World-640x360-v2.gif deleted file mode 100644 index ca3c4ab3c..000000000 Binary files a/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World-640x360-v2.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World-640x360.gif b/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World-640x360.gif deleted file mode 100644 index 99ef951b5..000000000 Binary files a/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World-640x360.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World-No-Wires-FINAL.gif b/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World-No-Wires-FINAL.gif deleted file mode 100644 index 8112a16ef..000000000 Binary files a/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World-No-Wires-FINAL.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World.webm b/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World.webm new file mode 100644 index 000000000..e6d5e34ab Binary files /dev/null and b/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World.webm differ diff --git a/documentation/asciidoc/microcontrollers/c_sdk/your_first_binary.adoc b/documentation/asciidoc/microcontrollers/c_sdk/your_first_binary.adoc index 91c9ba686..9beb1fc8e 100644 --- a/documentation/asciidoc/microcontrollers/c_sdk/your_first_binary.adoc +++ b/documentation/asciidoc/microcontrollers/c_sdk/your_first_binary.adoc @@ -4,7 +4,7 @@ The first program anyone writes when using a new microcontroller is to blink an LED on and off. The Raspberry Pi Pico comes with a single LED on-board. The LED is connected to `GP25` on the board's Raspberry Pi RP2040 for Pico, and `WL_GPIO0` on the Infineon 43439 wireless chip for Pico W. -image:images/Blink-an-LED-640x360-v2.gif[] +video::images/Blink-an-LED.webm[width="80%"] You can blink this on and off by, @@ -21,7 +21,7 @@ You can see the code on Github for the https://github.com/raspberrypi/pico-examp The next program anyone writes is to say 'Hello World' over a USB serial connection. -image:images/Hello-World-640x360-v2.gif[] +video::images/Hello-World.webm[width="80%"] . Download the https://datasheets.raspberrypi.com/soft/hello_world.uf2['Hello World' UF2]. . Push and hold the BOOTSEL button and plug your Pico into the USB port of your Raspberry Pi or other computer. diff --git a/documentation/asciidoc/microcontrollers/debug-probe/getting-started.adoc b/documentation/asciidoc/microcontrollers/debug-probe/getting-started.adoc index 00ab950fb..54fcb5d34 100644 --- a/documentation/asciidoc/microcontrollers/debug-probe/getting-started.adoc +++ b/documentation/asciidoc/microcontrollers/debug-probe/getting-started.adoc @@ -4,7 +4,7 @@ image:images/labelled-wiring.jpg[width="100%"] Depending on your setup, there are several ways to wire the Debug Probe to a xref:pico-series.adoc[Pico-series device]. Below, we connect the Debug Probe to a Raspberry Pi Pico H which has the newer three-pin JST-SH connector for SWD. -video::4RCZBZsfsek[youtube] +video::4RCZBZsfsek[youtube,width=80%,height=400px] Connect the following: diff --git a/documentation/asciidoc/microcontrollers/debug-probe/images/labelled-wiring-old.png b/documentation/asciidoc/microcontrollers/debug-probe/images/labelled-wiring-old.png deleted file mode 100644 index a8d689a20..000000000 Binary files a/documentation/asciidoc/microcontrollers/debug-probe/images/labelled-wiring-old.png and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/debug-probe/images/labelled-wiring.jpg b/documentation/asciidoc/microcontrollers/debug-probe/images/labelled-wiring.jpg index 514cc0581..81a0c3b1a 100644 Binary files a/documentation/asciidoc/microcontrollers/debug-probe/images/labelled-wiring.jpg and b/documentation/asciidoc/microcontrollers/debug-probe/images/labelled-wiring.jpg differ diff --git a/documentation/asciidoc/microcontrollers/debug-probe/images/wiring-real.jpg b/documentation/asciidoc/microcontrollers/debug-probe/images/wiring-real.jpg index d265a5e90..80f89a630 100644 Binary files a/documentation/asciidoc/microcontrollers/debug-probe/images/wiring-real.jpg and b/documentation/asciidoc/microcontrollers/debug-probe/images/wiring-real.jpg differ diff --git a/documentation/asciidoc/microcontrollers/micropython/drag-and-drop.adoc b/documentation/asciidoc/microcontrollers/micropython/drag-and-drop.adoc index 4845584b8..70931fea6 100644 --- a/documentation/asciidoc/microcontrollers/micropython/drag-and-drop.adoc +++ b/documentation/asciidoc/microcontrollers/micropython/drag-and-drop.adoc @@ -2,7 +2,7 @@ You can program your Pico by connecting it to a computer via USB, then dragging and dropping a file onto it so we've put together a downloadable UF2 file to let you install MicroPython more easily. -image::images/MicroPython-640x360-v2.gif[] +video::images/MicroPython.webm[width="80%"] Download the correct MicroPython UF2 file for your board: diff --git a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-640x360-v2.gif b/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-640x360-v2.gif deleted file mode 100644 index 4a350f0b0..000000000 Binary files a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-640x360-v2.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-640x360.gif b/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-640x360.gif deleted file mode 100644 index 8acc04df3..000000000 Binary files a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-640x360.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-640x480.gif b/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-640x480.gif deleted file mode 100644 index d816b70e6..000000000 Binary files a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-640x480.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-OLD.gif b/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-OLD.gif deleted file mode 100644 index 6d311a9e5..000000000 Binary files a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-OLD.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-Update-v1.gif b/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-Update-v1.gif deleted file mode 100644 index fc89da05e..000000000 Binary files a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-Update-v1.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython.webm b/documentation/asciidoc/microcontrollers/micropython/images/MicroPython.webm new file mode 100644 index 000000000..9ef956aa8 Binary files /dev/null and b/documentation/asciidoc/microcontrollers/micropython/images/MicroPython.webm differ diff --git a/documentation/asciidoc/microcontrollers/silicon/rp1.adoc b/documentation/asciidoc/microcontrollers/silicon/rp1.adoc index ad4f84e47..c6e66772b 100644 --- a/documentation/asciidoc/microcontrollers/silicon/rp1.adoc +++ b/documentation/asciidoc/microcontrollers/silicon/rp1.adoc @@ -8,7 +8,7 @@ image::images/rp1.jpg[alt="Architecture diagram of the RP1",width="70%"] RP1 is a 12×12mm, 0.65mm-pitch BGA southbridge, which provides the majority of the I/O capabilities for Raspberry Pi 5. -video::aioB40BGQYU[youtube] +video::aioB40BGQYU[youtube,width=80%,height=400px] It provides: diff --git a/jekyll-assets/css/style.css b/jekyll-assets/css/style.css index dc5ff2466..1a99ab932 100644 --- a/jekyll-assets/css/style.css +++ b/jekyll-assets/css/style.css @@ -924,7 +924,7 @@ span.mlabel { #content table.tableblock th { font-size: 0.85em; - background-color: var(--code-bg-colour); + background-color: var(--tab-bg-colour); text-align: left; padding: 5px 7px 5px 7px; border: 1px solid var(--subtle); @@ -1081,18 +1081,8 @@ div.admonitionblock td.content { div.videoblock { position: relative; overflow: hidden; - padding-top: 56.25%; + padding-top: 20px; padding-bottom: 20px; - margin-bottom: 30px; -} - -div.videoblock iframe { - position: absolute; - top: 0; - left: 0; - width: 100%; - height: 100%; - border: 0; } /* WHITEPAPER SIDEBARS */ diff --git a/scripts/create_auto_ninjabuild.py b/scripts/create_auto_ninjabuild.py index 51ac5cc5a..038ccf330 100755 --- a/scripts/create_auto_ninjabuild.py +++ b/scripts/create_auto_ninjabuild.py @@ -27,14 +27,23 @@ def scan_adoc(adoc_filename, apparent_filename, includes, src_images, dest_image includes[adoc_filename].add(include_adoc) scan_adoc(include_adoc, apparent_filename, includes, src_images, dest_images, parents.copy()) # look for image files - for image in re.findall(r'image::?(.+?)\[.*\]', contents): - if not (image.startswith('http:') or image.startswith('https:')): - image_filename = resolve_url(adoc_filename, image) - dest_image = resolve_url(apparent_filename, image) + for file in re.findall(r'image::?(.+?)\[.*\]', contents): + if not (file.startswith('http:') or file.startswith('https:')): + image_filename = resolve_url(adoc_filename, file) + dest_image = resolve_url(apparent_filename, file) if dest_image in dest_images and dest_images[dest_image] != image_filename: raise Exception("{} and {} would both end up as {}".format(dest_images[dest_image], image_filename, dest_image)) src_images[image_filename] = dest_image dest_images[dest_image] = image_filename + # look for video webm files, ignore youtube videos and all other formats for now (must update later if this changes) + for file in re.findall(r'video::?(.+?)\[.*\]', contents): + if file.endswith('.webm'): + video_filename = resolve_url(adoc_filename, file) + dest_video = resolve_url(apparent_filename, file) + if dest_video in dest_images and dest_images[dest_video] != video_filename: + raise Exception("{} and {} would both end up as {}".format(dest_images[dest_video], video_filename, dest_video)) + src_images[video_filename] = dest_video + dest_images[dest_video] = video_filename def add_entire_directory(tab_dir, dir_path, pages_set, src_images, dest_images): #print("Adding all files from {} directory".format(tab_dir)) diff --git a/tests/fixtures/_config.yml b/tests/fixtures/_config.yml deleted file mode 100644 index acfa472d3..000000000 --- a/tests/fixtures/_config.yml +++ /dev/null @@ -1,54 +0,0 @@ -# Welcome to Jekyll! -# -# This config file is meant for settings that affect your whole blog, values -# which you are expected to set up once and rarely edit after that. If you find -# yourself editing this file very often, consider using Jekyll's data files -# feature for the data you need to update frequently. -# -# For technical reasons, this file is *NOT* reloaded automatically when you use -# 'bundle exec jekyll serve'. If you change this file, please restart the server process. - -# Site settings -# These are used to personalize your new site. If you look in the HTML files, -# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on. -# You can create any custom variable you would like, and they will be accessible -# in the templates via {{ site.myvariable }}. -title: Raspberry Pi Documentation -description: >- # this means to ignore newlines until "baseurl:" - Raspberry Pi Documentation. -baseurl: "/documentation" # the subpath of your site, e.g. /blog -url: "" # the base hostname & protocol for your site, e.g. http://example.com -githuburl: "https://github.com/raspberrypi/documentation/" -githubbranch: master -githubbranch_edit: develop - -# Build settings -theme: minima -plugins: - - jekyll-asciidoc - - jekyll-feed - -# this corresponds to ASCIIDOC_BUILD_DIR in Makefile -source: build/jekyll - -# this corresponds to HTML_DIR in Makefile -destination: documentation/html - -sass: - sass_dir: css - quiet_deps: true - -asciidoctor: - template_dir: build/jekyll/_templates - -# Exclude from processing. -# The following items will not be processed, by default. Create a custom list -# to override the default setting. -# exclude: -# - Gemfile -# - Gemfile.lock -# - node_modules -# - vendor/bundle/ -# - vendor/cache/ -# - vendor/gems/ -# - vendor/ruby/ diff --git a/tests/fixtures/build_jekyll_data_index.json b/tests/fixtures/build_jekyll_data_index.json deleted file mode 100644 index b72edb205..000000000 --- a/tests/fixtures/build_jekyll_data_index.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "tabs": [ - { - "title": "Microcontrollers", - "path": "/microcontrollers/", - "subitems": [ - { - "title": "The C/C++ SDK", - "description": "Getting started with the C/C++ SDK", - "image": "full-sized/C-and-CPP.png", - "subpath": "c_sdk.adoc", - "path": "/microcontrollers/c_sdk.html", - "imagepath": "/images/full-sized/C-and-CPP.png" - }, - { - "title": "Product Information Portal", - "description": "Raspberry Pi compliance documents", - "imagepath": "/images/full-sized/PIP.png", - "url": "https://pip.raspberrypi.com/" - }, - { - "title": "Datasheets", - "description": "PDF-based documentation", - "imagepath": "/images/full-sized/Datasheets.png", - "url": "https://datasheets.raspberrypi.com" - }, - { - "title": "Tutorials", - "description": "Hands-on hardware and software tutorials", - "imagepath": "/images/full-sized/Tutorials.png", - "url": "https://www.raspberrypi.com/tutorials/" - }, - { - "title": "Forums", - "description": "User and product support forums", - "imagepath": "/images/full-sized/Forums.png", - "url": "https://forums.raspberrypi.com" - } - ] - } - ] -} \ No newline at end of file diff --git a/tests/fixtures/github_edit.adoc b/tests/fixtures/github_edit.adoc deleted file mode 100644 index ab8f43a94..000000000 --- a/tests/fixtures/github_edit.adoc +++ /dev/null @@ -1,2 +0,0 @@ -[.edit-link] -Edit this {{ github_edit_link }}[on GitHub] diff --git a/tests/fixtures/index.json b/tests/fixtures/index.json deleted file mode 100644 index 233ce8cd4..000000000 --- a/tests/fixtures/index.json +++ /dev/null @@ -1,191 +0,0 @@ -{ - "tabs": [ - { - "title": "Computers", - "path": "computers", - "default_tab": "yes", - "subitems": [ - { - "title": "Getting started", - "description": "How to get started with your Raspberry Pi", - "image": "full-sized/Getting-Started.png", - "subpath": "getting-started.adoc" - }, - { - "title": "Raspberry Pi OS", - "description": "The official Raspberry Pi operating system", - "image": "full-sized/Raspberry-Pi-OS.png", - "subpath": "os.adoc" - }, - { - "title": "Configuration", - "description": "Configuring your Raspberry Pi's settings", - "image": "full-sized/Configuration.png", - "subpath": "configuration.adoc" - }, - { - "title": "The config.txt file", - "description": "Low-level settings control", - "image": "full-sized/The-config-txt-file.png", - "subpath": "config_txt.adoc" - }, - { - "title": "Legacy config.txt options", - "description": "Options which may be useful for OSes other than Raspberry Pi OS", - "image": "full-sized/Legacy-config-txt.png", - "subpath": "legacy_config_txt.adoc" - }, - { - "title": "The Linux kernel", - "description": "How to configure and build a custom kernel for your Raspberry Pi", - "image": "full-sized/Linux-Kernel.png", - "subpath": "linux_kernel.adoc" - }, - { - "title": "Remote access", - "description": "Accessing your Raspberry Pi remotely", - "image": "full-sized/Remote-Access.png", - "subpath": "remote-access.adoc" - }, - { - "title": "Camera software", - "description": "Software and libraries for Raspberry Pi camera hardware", - "image": "full-sized/Camera.png", - "subpath": "camera_software.adoc" - }, - { - "title": "Raspberry Pi hardware", - "description": "Technical information about Raspberry Pi hardware", - "image": "full-sized/Raspberry-Pi-Hardware.png", - "subpath": "raspberry-pi.adoc" - }, - { - "title": "Compute Module hardware", - "description": "Technical information about Raspberry Pi Compute Module hardware", - "image": "full-sized/Compute-Module-Hardware.png", - "subpath": "compute-module.adoc" - }, - { - "title": "Processors", - "description": "Technical information about the CPUs used by Raspberry Pi", - "image": "full-sized/Processors.png", - "subpath": "processors.adoc" - } - ] - }, - { - "title": "Accessories", - "path": "accessories", - "default_tab": "no", - "subitems": [ - { - "title": "Camera", - "description": "Raspberry Pi camera boards", - "image": "full-sized/Camera.png", - "subpath": "camera.adoc" - }, - { - "title": "Display", - "description": "The Raspberry Pi Touch Display", - "image": "full-sized/Display.png", - "subpath": "display.adoc" - }, - { - "title": "Keyboard and mouse", - "description": "Official Raspberry Pi keyboard and mouse", - "image": "full-sized/Keyboard-and-Mouse.png", - "subpath": "keyboard-and-mouse.adoc" - }, - { - "title": "Build HAT", - "description": "How to use the Build HAT", - "image": "full-sized/Build-HAT.png", - "subpath": "build-hat.adoc" - }, - { - "title": "Sense HAT", - "description": "How to use the Sense HAT", - "image": "full-sized/Sense-HAT.png", - "subpath": "sense-hat.adoc" - }, - { - "title": "TV HAT", - "description": "How to watch TV on your Raspberry Pi", - "image": "full-sized/TV-HAT.png", - "subpath": "tv-hat.adoc" - }, - { - "title": "Raspberry Pi Audio", - "description": "High-definition audio with Raspberry Pi", - "image": "full-sized/Audio-HATs.png", - "subpath": "audio.adoc" - }, - { - "title": "Designing a HAT", - "description": "Information on the HAT specification", - "image": "full-sized/Designing-a-HAT.png", - "url": "https://github.com/raspberrypi/hats" - } - ] - }, - { - "title": "Microcontrollers", - "path": "microcontrollers", - "subitems": [ - { - "title": "Silicon", - "description": "Raspberry Pi's flagship microcontroller device", - "image": "full-sized/silicon.png", - "subpath": "silicon.adoc" - }, - { - "title": "Raspberry Pi Pico-series", - "description": "Support for Raspberry Pi Pico-series devices", - "image": "full-sized/pico-series.png", - "subpath": "pico-series.adoc" - }, - { - "title": "Raspberry Pi Debug Probe", - "description": "Supports Arm Serial Wire Debug (SWD), and acts as a UART bridge", - "image": "full-sized/Debug-Probe.png", - "subpath": "debug-probe.adoc" - }, - { - "title": "RP1", - "description": "Our southbridge for Raspberry Pi 5", - "image": "full-sized/RP1.png", - "subpath": "rp1.adoc" - }, - { - "title": "MicroPython", - "description": "Getting started with MicroPython", - "image": "full-sized/MP.png", - "subpath": "micropython.adoc" - }, - { - "title": "The C/C++ SDK", - "description": "Getting started with the C/C++ SDK", - "image": "full-sized/C-and-CPP.png", - "subpath": "c_sdk.adoc" - } - ] - }, - { - "title": "Services", - "path": "services", - "subitems": [ - { - "title": "Raspberry Pi ID", - "description": "Our identity service", - "image": "full-sized/Raspberry-Pi-ID.png", - "subpath": "id.adoc" - } - ] - }, - { - "title": "Pico C SDK", - "from_json": "picosdk_index.json", - "directory": "pico-sdk" - } - ] -} diff --git a/tests/fixtures/microcontrollers/c_sdk.adoc b/tests/fixtures/microcontrollers/c_sdk.adoc deleted file mode 100644 index 2211b8b01..000000000 --- a/tests/fixtures/microcontrollers/c_sdk.adoc +++ /dev/null @@ -1,7 +0,0 @@ -include::c_sdk/sdk_setup.adoc[] - -include::c_sdk/official_sdk.adoc[] - -include::c_sdk/your_first_binary.adoc[] - -include::c_sdk/quick_start.adoc[] \ No newline at end of file diff --git a/tests/fixtures/microcontrollers/c_sdk/images/Blink-an-LED-640x360-v2.gif b/tests/fixtures/microcontrollers/c_sdk/images/Blink-an-LED-640x360-v2.gif deleted file mode 100644 index ac47dd4c1..000000000 Binary files a/tests/fixtures/microcontrollers/c_sdk/images/Blink-an-LED-640x360-v2.gif and /dev/null differ diff --git a/tests/fixtures/microcontrollers/c_sdk/images/Blink-an-LED-640x360.gif b/tests/fixtures/microcontrollers/c_sdk/images/Blink-an-LED-640x360.gif deleted file mode 100644 index a2a1042e6..000000000 Binary files a/tests/fixtures/microcontrollers/c_sdk/images/Blink-an-LED-640x360.gif and /dev/null differ diff --git a/tests/fixtures/microcontrollers/c_sdk/images/Blink-an-LED-FINAL.gif b/tests/fixtures/microcontrollers/c_sdk/images/Blink-an-LED-FINAL.gif deleted file mode 100644 index cf249e8ef..000000000 Binary files a/tests/fixtures/microcontrollers/c_sdk/images/Blink-an-LED-FINAL.gif and /dev/null differ diff --git a/tests/fixtures/microcontrollers/c_sdk/images/Hello-World-640x360-v2.gif b/tests/fixtures/microcontrollers/c_sdk/images/Hello-World-640x360-v2.gif deleted file mode 100644 index ca3c4ab3c..000000000 Binary files a/tests/fixtures/microcontrollers/c_sdk/images/Hello-World-640x360-v2.gif and /dev/null differ diff --git a/tests/fixtures/microcontrollers/c_sdk/images/Hello-World-640x360.gif b/tests/fixtures/microcontrollers/c_sdk/images/Hello-World-640x360.gif deleted file mode 100644 index 99ef951b5..000000000 Binary files a/tests/fixtures/microcontrollers/c_sdk/images/Hello-World-640x360.gif and /dev/null differ diff --git a/tests/fixtures/microcontrollers/c_sdk/images/Hello-World-No-Wires-FINAL.gif b/tests/fixtures/microcontrollers/c_sdk/images/Hello-World-No-Wires-FINAL.gif deleted file mode 100644 index 8112a16ef..000000000 Binary files a/tests/fixtures/microcontrollers/c_sdk/images/Hello-World-No-Wires-FINAL.gif and /dev/null differ diff --git a/tests/fixtures/microcontrollers/c_sdk/official_sdk.adoc b/tests/fixtures/microcontrollers/c_sdk/official_sdk.adoc deleted file mode 100644 index faca0f709..000000000 --- a/tests/fixtures/microcontrollers/c_sdk/official_sdk.adoc +++ /dev/null @@ -1,32 +0,0 @@ -== Raspberry Pi Pico C/C++ SDK - -Our official C SDK can be used from the command line, or from popular integrated development environments like Visual Studio Code, Eclipse, and CLion. To get started, download our C/{cpp} SDK and Examples, and take a look at our 'https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[getting started]' documentation to get going. Or for a quick setup see the next section. - -* The SDK https://github.com/raspberrypi/pico-sdk[Github repository] - -* The Examples https://github.com/raspberrypi/pico-examples[Github repository] - -You can find documentation around the C/{cpp} SDK at; - -https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[Getting started with Raspberry Pi Pico]:: C/{cpp} development with Raspberry Pi Pico and other RP2040-based microcontroller boards - -https://datasheets.raspberrypi.com/picow/connecting-to-the-internet-with-pico-w.pdf[Connecting to the Internet with Raspberry Pi Pico W]:: Getting Raspberry Pi Pico W online with C/{cpp} or MicroPython - -https://datasheets.raspberrypi.com/pico/raspberry-pi-pico-c-sdk.pdf[Raspberry Pi Pico C/{cpp} SDK]:: Libraries and tools for C/{cpp} development on RP2040 microcontrollers - -xref:../pico-sdk/index_doxygen.adoc[API level documentation]:: Documentation for the Raspberry Pi Pico C/{cpp} SDK - -[NOTE] -==== -If you are building applications with the C/{cpp} SDK and targeting boards other than the Raspberry Pi Pico, you will need to pass `-DPICO_BOARD=boardname` to CMake. Here `boardname` is the name of your board, e.g. for the Adafruit Feather RP2040 you should pass `-DPICO_BOARD=adafruit_feather_rp2040`. See the https://github.com/raspberrypi/pico-sdk/tree/master/src/boards[`boards/` directory] in the Raspberry Pi Pico SDK, and the https://forums.raspberrypi.com/viewtopic.php?f=147&t=304393[forums], for more information. -==== - -[NOTE] -==== -Documentation introducing working with Wi-Fi and Bluetooth on Raspberry Pi Pico W with C/{cpp} or MicroPython is presented in the https://datasheets.raspberrypi.com/picow/connecting-to-the-internet-with-pico-w.pdf[Connecting to the Internet with Raspberry Pi Pico W] book. -==== - -[NOTE] -==== -If you are building applications with the C/{cpp} SDK for Raspberry Pi Pico W and, to connect to a network you will need to pass `-DPICO_BOARD=pico_w -DWIFI_SSID="Your Network" -DWIFI_PASSWORD="Your Password"` to CMake. If you only need to enable Bluetooth support then you do not need to pass a SSID and password, but still need to pass the `-DPICO_BOARD=pico_w` string to CMake. -==== diff --git a/tests/fixtures/microcontrollers/c_sdk/quick_start.adoc b/tests/fixtures/microcontrollers/c_sdk/quick_start.adoc deleted file mode 100644 index 36df8da7d..000000000 --- a/tests/fixtures/microcontrollers/c_sdk/quick_start.adoc +++ /dev/null @@ -1,89 +0,0 @@ -== Quick-start your own project - -NOTE: The following instructions are terse, and Linux-based only. For detailed steps, instructions for other platforms, and just in general, we recommend you see the https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[Getting started with Raspberry Pi Pico] and https://datasheets.raspberrypi.com/pico/raspberry-pi-pico-c-sdk.pdf[Raspberry Pi Pico C/{cpp} SDK] books. - -Install CMake (at least version 3.13), and GCC cross compiler - ----- -$ sudo apt install cmake gcc-arm-none-eabi libnewlib-arm-none-eabi libstdc++-arm-none-eabi-newlib ----- - -Set up your project to point to use the Raspberry Pi Pico SDK by cloning the SDK locally: - ----- -$ git clone https://github.com/raspberrypi/pico-sdk.git ----- - -Copy `external/pico_sdk_import.cmake` from the SDK into your project directory - -Set `PICO_SDK_PATH` to the SDK location in your environment, or pass it (`-DPICO_SDK_PATH=`) to `cmake` later. - -Setup a `CMakeLists.txt` like: - ----- -cmake_minimum_required(VERSION 3.13) - -# initialize the SDK based on PICO_SDK_PATH -# note: this must happen before project() -include(pico_sdk_import.cmake) - -project(my_project) - -# initialize the Raspberry Pi Pico SDK -pico_sdk_init() - -# rest of your project ----- - -Go ahead and write your code, see https://github.com/raspberrypi/pico-examples[pico-examples] or the https://datasheets.raspberrypi.com/pico/raspberry-pi-pico-c-sdk.pdf[Raspberry Pi Pico C/{cpp} SDK] book for more information on how to go about that. - -About the simplest you can do is a single source file (e.g. `hello_world.c`) - ----- -#include -#include "pico/stdlib.h" - -int main() { - setup_default_uart(); - printf("Hello, world!\n"); - return 0; -} ----- - -and add the following to your CMakeLists.txt: - ----- -add_executable(hello_world - hello_world.c -) - -# Add pico_stdlib library which aggregates commonly used features -target_link_libraries(hello_world pico_stdlib) - -# create map/bin/hex/uf2 file in addition to ELF. -pico_add_extra_outputs(hello_world) ----- - -NOTE: This example uses the default UART for stdout; if you want to use the default USB see the hello-usb example. - -Setup a CMake build directory. For example, if not using an IDE: - ----- -$ mkdir build -$ cd build -$ cmake .. ----- - -When building for a board other than the Raspberry Pi Pico, you should pass `-DPICO_BOARD=board_name` to the cmake command above, e.g. cmake `-DPICO_BOARD=pico_w ..` to configure the SDK and build options accordingly for that particular board. - -Doing so sets up various compiler defines (e.g. default pin numbers for UART and other hardware) and in certain cases also enables the use of additional libraries (e.g. wireless support when building for `PICO_BOARD=pico_w`) which cannot be built without a board which provides the requisite functionality. - -For a list of boards defined in the SDK itself, look in https://github.com/raspberrypi/pico-sdk/blob/master/src/boards/include/boards[this directory] which has a header for each named board. - -Make your target from the build directory you created. - ----- -$ make hello_world ----- - -You now have `hello_world.elf` to load via a debugger, or `hello_world.uf2` that can be installed and run on your Raspberry Pi Pico via drag and drop. diff --git a/tests/fixtures/microcontrollers/c_sdk/sdk_setup.adoc b/tests/fixtures/microcontrollers/c_sdk/sdk_setup.adoc deleted file mode 100644 index a72fff7cf..000000000 --- a/tests/fixtures/microcontrollers/c_sdk/sdk_setup.adoc +++ /dev/null @@ -1,6 +0,0 @@ -== SDK Setup - -For a full walk-through of how to get going with the C/{cpp} SDK, you should read our 'https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[getting started]' documentation. However, if you are intending to develop for Pico on a Raspberry Pi, then you can set up the C/{cpp} toolchain quickly by running our https://raw.githubusercontent.com/raspberrypi/pico-setup/master/pico_setup.sh[setup script] from the command line. - -NOTE: You should make sure the OS on your Raspberry Pi is up to date before running the setup script. - diff --git a/tests/fixtures/microcontrollers/c_sdk/your_first_binary.adoc b/tests/fixtures/microcontrollers/c_sdk/your_first_binary.adoc deleted file mode 100644 index 696b6f0c2..000000000 --- a/tests/fixtures/microcontrollers/c_sdk/your_first_binary.adoc +++ /dev/null @@ -1,42 +0,0 @@ -== Your First Binaries - -WARNING: If you are using an Apple Mac, and running macOS Ventura, there has been a change in how the Finder works which causes drag-and-drop to fail. Please see our https://www.raspberrypi.com/news/the-ventura-problem/[blog post] for a full explanation, and workarounds, and our https://github.com/raspberrypi/pico-sdk/issues/1081[Github issue] tracking the problem for the current status. - -=== Blink an LED - -The first program anyone writes when using a new microcontroller is to blink an LED on and off. The Raspberry Pi Pico comes with a single LED on-board. The LED is connected to `GP25` on the board's Raspberry Pi RP2040 for Pico, and `WL_GPIO0` on the Infineon 43439 wireless chip for Pico W. - -image:images/Blink-an-LED-640x360-v2.gif[] - -You can blink this on and off by, - -. Download the Blink UF2 https://datasheets.raspberrypi.com/soft/blink.uf2[for Raspberry Pi Pico], or https://datasheets.raspberrypi.com/soft/blink_picow.uf2[for Pico W]. -. Push and hold the BOOTSEL button and plug your Pico into the USB port of your Raspberry Pi or other computer. -. It will mount as a Mass Storage Device called RPI-RP2. -. Drag and drop the Blink UF2 binary onto the RPI-RP2 volume. Pico will reboot. - -You should see the on-board LED blinking. - -You can see the code on Github for the https://github.com/raspberrypi/pico-examples/blob/master/blink/blink.c[Raspberry Pi Pico] and https://github.com/raspberrypi/pico-examples/blob/master/pico_w/wifi/blink/picow_blink.c[Pico W] versions. - -=== Say "Hello World" - -The next program anyone writes is to say 'Hello World' over a USB serial connection. - -image:images/Hello-World-640x360-v2.gif[] - -. Download the https://datasheets.raspberrypi.com/soft/hello_world.uf2['Hello World' UF2]. -. Push and hold the BOOTSEL button and plug your Pico into the USB port of your Raspberry Pi or other computer. -. It will mount as a Mass Storage Device called RPI-RP2. -. Drag and drop the 'Hello World' UF2 binary onto the RPI-RP2 volume. Pico will reboot. -. Open a Terminal window and type: -+ -[source] ------- -sudo apt install minicom -minicom -b 115200 -o -D /dev/ttyACM0 ------- - -You should see 'Hello, world!' printed to the Terminal. - -You can see the code https://github.com/raspberrypi/pico-examples/blob/master/hello_world/usb/hello_usb.c[on Github] diff --git a/tests/fixtures/pico-sdk/group__channel__config.adoc b/tests/fixtures/pico-sdk/group__channel__config.adoc deleted file mode 100644 index d39641146..000000000 --- a/tests/fixtures/pico-sdk/group__channel__config.adoc +++ /dev/null @@ -1,32 +0,0 @@ -[[channel_config]] -== channel_config - -++++ - - -
Part of: Hardware APIs » hardware_dma

DMA channel configuration . -More...

- -++++ - -[[rpipbcecd949811e64d5957a]] -=== Functions - - -++++ - - - -++++ - -[[rpip1326aa77c0728be36c25]] -=== Detailed Description - - -++++ - -

DMA channel configuration .

-

A DMA channel needs to be configured, these functions provide handy helpers to set up configuration structures. See dma_channel_config

- -++++ diff --git a/tests/fixtures/pico-sdk/picosdk_index.json b/tests/fixtures/pico-sdk/picosdk_index.json deleted file mode 100644 index f41680d24..000000000 --- a/tests/fixtures/pico-sdk/picosdk_index.json +++ /dev/null @@ -1,417 +0,0 @@ -[ - { - "group_id": "index_doxygen", - "name": "Introduction", - "description": "An introduction to the Pico SDK", - "html": "index_doxygen.html", - "subitems": [] - }, - { - "group_id": "hardware", - "name": "Hardware APIs", - "description": "This group of libraries provides a thin and efficient C API / abstractions to access the RP2040 hardware without having to read and write hardware registers directly. ", - "html": "group__hardware.html", - "subitems": [ - { - "name": "hardware_adc", - "file": "group__hardware__adc.adoc", - "html": "group__hardware__adc.html", - "subitems": [] - }, - { - "name": "hardware_base", - "file": "group__hardware__base.adoc", - "html": "group__hardware__base.html", - "subitems": [] - }, - { - "name": "hardware_claim", - "file": "group__hardware__claim.adoc", - "html": "group__hardware__claim.html", - "subitems": [] - }, - { - "name": "hardware_clocks", - "file": "group__hardware__clocks.adoc", - "html": "group__hardware__clocks.html", - "subitems": [] - }, - { - "name": "hardware_divider", - "file": "group__hardware__divider.adoc", - "html": "group__hardware__divider.html", - "subitems": [] - }, - { - "name": "hardware_dma", - "file": "group__hardware__dma.adoc", - "html": "group__hardware__dma.html", - "subitems": [] - }, - { - "name": "hardware_exception", - "file": "group__hardware__exception.adoc", - "html": "group__hardware__exception.html", - "subitems": [] - }, - { - "name": "hardware_flash", - "file": "group__hardware__flash.adoc", - "html": "group__hardware__flash.html", - "subitems": [] - }, - { - "name": "hardware_gpio", - "file": "group__hardware__gpio.adoc", - "html": "group__hardware__gpio.html", - "subitems": [] - }, - { - "name": "hardware_i2c", - "file": "group__hardware__i2c.adoc", - "html": "group__hardware__i2c.html", - "subitems": [] - }, - { - "name": "hardware_interp", - "file": "group__hardware__interp.adoc", - "html": "group__hardware__interp.html", - "subitems": [] - }, - { - "name": "hardware_irq", - "file": "group__hardware__irq.adoc", - "html": "group__hardware__irq.html", - "subitems": [] - }, - { - "name": "hardware_pio", - "file": "group__hardware__pio.adoc", - "html": "group__hardware__pio.html", - "subitems": [] - }, - { - "name": "hardware_pll", - "file": "group__hardware__pll.adoc", - "html": "group__hardware__pll.html", - "subitems": [] - }, - { - "name": "hardware_pwm", - "file": "group__hardware__pwm.adoc", - "html": "group__hardware__pwm.html", - "subitems": [] - }, - { - "name": "hardware_resets", - "file": "group__hardware__resets.adoc", - "html": "group__hardware__resets.html", - "subitems": [] - }, - { - "name": "hardware_rtc", - "file": "group__hardware__rtc.adoc", - "html": "group__hardware__rtc.html", - "subitems": [] - }, - { - "name": "hardware_spi", - "file": "group__hardware__spi.adoc", - "html": "group__hardware__spi.html", - "subitems": [] - }, - { - "name": "hardware_sync", - "file": "group__hardware__sync.adoc", - "html": "group__hardware__sync.html", - "subitems": [] - }, - { - "name": "hardware_timer", - "file": "group__hardware__timer.adoc", - "html": "group__hardware__timer.html", - "subitems": [] - }, - { - "name": "hardware_uart", - "file": "group__hardware__uart.adoc", - "html": "group__hardware__uart.html", - "subitems": [] - }, - { - "name": "hardware_vreg", - "file": "group__hardware__vreg.adoc", - "html": "group__hardware__vreg.html", - "subitems": [] - }, - { - "name": "hardware_watchdog", - "file": "group__hardware__watchdog.adoc", - "html": "group__hardware__watchdog.html", - "subitems": [] - }, - { - "name": "hardware_xosc", - "file": "group__hardware__xosc.adoc", - "html": "group__hardware__xosc.html", - "subitems": [] - } - ] - }, - { - "group_id": "high_level", - "name": "High Level APIs", - "description": "This group of libraries provide higher level functionality that isn't hardware related or provides a richer set of functionality above the basic hardware interfaces ", - "html": "group__high__level.html", - "subitems": [ - { - "name": "pico_async_context", - "file": "group__pico__async__context.adoc", - "html": "group__pico__async__context.html", - "subitems": [] - }, - { - "name": "pico_flash", - "file": "group__pico__flash.adoc", - "html": "group__pico__flash.html", - "subitems": [] - }, - { - "name": "pico_i2c_slave", - "file": "group__pico__i2c__slave.adoc", - "html": "group__pico__i2c__slave.html", - "subitems": [] - }, - { - "name": "pico_multicore", - "file": "group__pico__multicore.adoc", - "html": "group__pico__multicore.html", - "subitems": [] - }, - { - "name": "pico_rand", - "file": "group__pico__rand.adoc", - "html": "group__pico__rand.html", - "subitems": [] - }, - { - "name": "pico_stdlib", - "file": "group__pico__stdlib.adoc", - "html": "group__pico__stdlib.html", - "subitems": [] - }, - { - "name": "pico_sync", - "file": "group__pico__sync.adoc", - "html": "group__pico__sync.html", - "subitems": [] - }, - { - "name": "pico_time", - "file": "group__pico__time.adoc", - "html": "group__pico__time.html", - "subitems": [] - }, - { - "name": "pico_unique_id", - "file": "group__pico__unique__id.adoc", - "html": "group__pico__unique__id.html", - "subitems": [] - }, - { - "name": "pico_util", - "file": "group__pico__util.adoc", - "html": "group__pico__util.html", - "subitems": [] - } - ] - }, - { - "group_id": "third_party", - "name": "Third-party Libraries", - "description": "Third party libraries for implementing high level functionality. ", - "html": "group__third__party.html", - "subitems": [ - { - "name": "tinyusb_device", - "file": "group__tinyusb__device.adoc", - "html": "group__tinyusb__device.html", - "subitems": [] - }, - { - "name": "tinyusb_host", - "file": "group__tinyusb__host.adoc", - "html": "group__tinyusb__host.html", - "subitems": [] - } - ] - }, - { - "group_id": "networking", - "name": "Networking Libraries", - "description": "Functions for implementing networking ", - "html": "group__networking.html", - "subitems": [ - { - "name": "pico_btstack", - "file": "group__pico__btstack.adoc", - "html": "group__pico__btstack.html", - "subitems": [] - }, - { - "name": "pico_lwip", - "file": "group__pico__lwip.adoc", - "html": "group__pico__lwip.html", - "subitems": [] - }, - { - "name": "pico_cyw43_driver", - "file": "group__pico__cyw43__driver.adoc", - "html": "group__pico__cyw43__driver.html", - "subitems": [] - }, - { - "name": "pico_cyw43_arch", - "file": "group__pico__cyw43__arch.adoc", - "html": "group__pico__cyw43__arch.html", - "subitems": [] - } - ] - }, - { - "group_id": "runtime", - "name": "Runtime Infrastructure", - "description": "Libraries that are used to provide efficient implementation of certain language level and C library functions, as well as CMake INTERFACE libraries abstracting the compilation and link steps in the SDK ", - "html": "group__runtime.html", - "subitems": [ - { - "name": "boot_stage2", - "file": "group__boot__stage2.adoc", - "html": "group__boot__stage2.html", - "subitems": [] - }, - { - "name": "pico_base", - "file": "group__pico__base.adoc", - "html": "group__pico__base.html", - "subitems": [] - }, - { - "name": "pico_binary_info", - "file": "group__pico__binary__info.adoc", - "html": "group__pico__binary__info.html", - "subitems": [] - }, - { - "name": "pico_bit_ops", - "file": "group__pico__bit__ops.adoc", - "html": "group__pico__bit__ops.html", - "subitems": [] - }, - { - "name": "pico_bootrom", - "file": "group__pico__bootrom.adoc", - "html": "group__pico__bootrom.html", - "subitems": [] - }, - { - "name": "pico_bootsel_via_double_reset", - "file": "group__pico__bootsel__via__double__reset.adoc", - "html": "group__pico__bootsel__via__double__reset.html", - "subitems": [] - }, - { - "name": "pico_cxx_options", - "file": "group__pico__cxx__options.adoc", - "html": "group__pico__cxx__options.html", - "subitems": [] - }, - { - "name": "pico_divider", - "file": "group__pico__divider.adoc", - "html": "group__pico__divider.html", - "subitems": [] - }, - { - "name": "pico_double", - "file": "group__pico__double.adoc", - "html": "group__pico__double.html", - "subitems": [] - }, - { - "name": "pico_float", - "file": "group__pico__float.adoc", - "html": "group__pico__float.html", - "subitems": [] - }, - { - "name": "pico_int64_ops", - "file": "group__pico__int64__ops.adoc", - "html": "group__pico__int64__ops.html", - "subitems": [] - }, - { - "name": "pico_malloc", - "file": "group__pico__malloc.adoc", - "html": "group__pico__malloc.html", - "subitems": [] - }, - { - "name": "pico_mem_ops", - "file": "group__pico__mem__ops.adoc", - "html": "group__pico__mem__ops.html", - "subitems": [] - }, - { - "name": "pico_platform", - "file": "group__pico__platform.adoc", - "html": "group__pico__platform.html", - "subitems": [] - }, - { - "name": "pico_printf", - "file": "group__pico__printf.adoc", - "html": "group__pico__printf.html", - "subitems": [] - }, - { - "name": "pico_runtime", - "file": "group__pico__runtime.adoc", - "html": "group__pico__runtime.html", - "subitems": [] - }, - { - "name": "pico_stdio", - "file": "group__pico__stdio.adoc", - "html": "group__pico__stdio.html", - "subitems": [] - }, - { - "name": "pico_standard_link", - "file": "group__pico__standard__link.adoc", - "html": "group__pico__standard__link.html", - "subitems": [] - } - ] - }, - { - "group_id": "misc", - "name": "External API Headers", - "description": "Headers for interfaces that are shared with code outside of the SDK ", - "html": "group__misc.html", - "subitems": [ - { - "name": "boot_picoboot", - "file": "group__boot__picoboot.adoc", - "html": "group__boot__picoboot.html", - "subitems": [] - }, - { - "name": "boot_uf2", - "file": "group__boot__uf2.adoc", - "html": "group__boot__uf2.html", - "subitems": [] - } - ] - } -] \ No newline at end of file diff --git a/tests/run_documentation_tests.sh b/tests/run_documentation_tests.sh deleted file mode 100755 index 016463362..000000000 --- a/tests/run_documentation_tests.sh +++ /dev/null @@ -1,10 +0,0 @@ -#! /bin/bash - -# run from the top level: ./tests/run_documentation_tests.sh - -python3 -m unittest tests.test_create_build_adoc_doxygen -python3 -m unittest tests.test_create_build_adoc_include -python3 -m unittest tests.test_create_build_adoc -python3 -m unittest tests.test_create_nav -cd scripts/ -python3 -m unittest tests.test_doxygen_adoc diff --git a/tests/test_create_build_adoc.py b/tests/test_create_build_adoc.py deleted file mode 100755 index 772bb816b..000000000 --- a/tests/test_create_build_adoc.py +++ /dev/null @@ -1,80 +0,0 @@ -#!/usr/bin/env python3 - -import os -import re -import subprocess -import shutil -import unittest -import json -import datetime - -# to run: on the command line, run all scripts from the top dir: pytest, -# or: python3 -m unittest tests.test_create_build_adoc - -class TestCreateBuildAdoc(unittest.TestCase): - def setUp(self): - script_path = os.path.realpath(__file__) - top_dir = re.sub(r"/tests/[^/]+$", "", script_path) - self.fixtures_path = os.path.join(top_dir, "tests", "fixtures") - self.script_path = os.path.join(top_dir, "scripts") - self.process_path = os.path.join(self.script_path, "create_build_adoc.py") - self.build_path = os.path.join(self.fixtures_path, "build") - self.output_path = os.path.join(self.build_path, "jekyll", "microcontrollers") - self.output_file = os.path.join(self.output_path, "c_sdk.adoc") - - def tearDown(self): - shutil.rmtree(self.build_path) - - def test_create_build_adoc(self): - os.makedirs(self.output_path) - index_json = os.path.join(self.fixtures_path, "index.json") - config_yaml = os.path.join(self.fixtures_path, "_config.yml") - github_edit = os.path.join(self.fixtures_path, "github_edit.adoc") - src_adoc = os.path.join(self.fixtures_path, "microcontrollers", "c_sdk.adoc") - includes_dir = os.path.join(self.fixtures_path, "build", "adoc_includes") - build_adoc = self.output_file - - subprocess.run(["python3", self.process_path, index_json, config_yaml, github_edit, src_adoc, includes_dir, build_adoc]) - expected = ''':parentdir: microcontrollers -:page-layout: docs -:includedir: {0} -:doctitle: The C/C++ SDK - Raspberry Pi Documentation -:page-sub_title: The C/C++ SDK -:sectanchors: -:figure-caption!: -:source-highlighter: rouge - -include::{{includedir}}/{{parentdir}}/c_sdk/sdk_setup.adoc[] - -include::{{includedir}}/{{parentdir}}/c_sdk/official_sdk.adoc[] - -include::{{includedir}}/{{parentdir}}/c_sdk/your_first_binary.adoc[] - -include::{{includedir}}/{{parentdir}}/c_sdk/quick_start.adoc[] -'''.format(os.path.join(self.build_path, "adoc_includes")) - res = "" - if os.path.isfile(self.output_file): - with open(self.output_file) as f: - res = f.read() - self.assertTrue(expected == res) - -def run_create_build_adoc_tests(event, context): - suite = unittest.defaultTestLoader.loadTestsFromTestCase(TestCreateBuildAdoc) - result = unittest.TextTestRunner(verbosity=2).run(suite) - if result.wasSuccessful(): - body = { "message": "Tests passed!" } - response = { - "statusCode": 200, - "body": json.dumps(body) - } - return response - else : - body = { "message": "Tests failed!" } - response = { - "statusCode": 500, - "body": json.dumps(body) - } - return response - -if __name__ == '__main__': - unittest.main() diff --git a/tests/test_create_build_adoc_doxygen.py b/tests/test_create_build_adoc_doxygen.py deleted file mode 100644 index 0686530df..000000000 --- a/tests/test_create_build_adoc_doxygen.py +++ /dev/null @@ -1,108 +0,0 @@ -#!/usr/bin/env python3 - -import os -import re -import subprocess -import shutil -import unittest -import json -import datetime - -# 503 281 1142 - -# to run: on the command line, run all scripts from the top dir: pytest, -# or: python3 -m unittest tests.test_create_build_adoc_doxygen - -class TestCreateBuildAdocDoxygen(unittest.TestCase): - def setUp(self): - script_path = os.path.realpath(__file__) - top_dir = re.sub(r"/tests/[^/]+$", "", script_path) - self.fixtures_path = os.path.join(top_dir, "tests", "fixtures") - self.script_path = os.path.join(top_dir, "scripts") - self.process_path = os.path.join(self.script_path, "create_build_adoc_doxygen.py") - self.build_path = os.path.join(self.fixtures_path, "build") - self.output_path = os.path.join(self.build_path, "jekyll", "pico-sdk") - self.output_file = os.path.join(self.output_path, "group__channel__config.adoc") - - def tearDown(self): - shutil.rmtree(self.build_path) - - def test_create_build_adoc_doxygen(self): - os.makedirs(self.output_path) - index_json = os.path.join(self.fixtures_path, "index.json") - config_yaml = os.path.join(self.fixtures_path, "_config.yml") - src_adoc = os.path.join(self.fixtures_path, "pico-sdk", "group__channel__config.adoc") - picosdk_json = os.path.join(self.fixtures_path, "pico-sdk", "picosdk_index.json") - includes_dir = os.path.join(self.fixtures_path, "build", "adoc_includes") - build_adoc = self.output_file - - subprocess.run(["python3", self.process_path, index_json, config_yaml, src_adoc, picosdk_json, includes_dir, build_adoc]) - expected = ''':parentdir: pico-sdk -:page-layout: docs -:includedir: {0} -:doctitle: group__channel__config - Raspberry Pi Documentation -:page-sub_title: group__channel__config -:sectanchors: -:figure-caption!: -:source-highlighter: rouge - -[[channel_config]] -== channel_config - -++++ - - -
Part of: Hardware APIs » hardware_dma

DMA channel configuration . -More...

- -++++ - -[[rpipbcecd949811e64d5957a]] -=== Functions - - -++++ - - - -++++ - -[[rpip1326aa77c0728be36c25]] -=== Detailed Description - - -++++ - -

DMA channel configuration .

-

A DMA channel needs to be configured, these functions provide handy helpers to set up configuration structures. See dma_channel_config

- -++++ - -'''.format(os.path.join(self.fixtures_path, "build", "adoc_includes")) - res = "" - if os.path.isfile(self.output_file): - with open(self.output_file) as f: - res = f.read() - self.assertTrue(expected == res) - -def run_create_build_adoc_doxygen_tests(event, context): - suite = unittest.defaultTestLoader.loadTestsFromTestCase(TestCreateBuildAdocDoxygen) - result = unittest.TextTestRunner(verbosity=2).run(suite) - if result.wasSuccessful(): - body = { "message": "Tests passed!" } - response = { - "statusCode": 200, - "body": json.dumps(body) - } - return response - else : - body = { "message": "Tests failed!" } - response = { - "statusCode": 500, - "body": json.dumps(body) - } - return response - -if __name__ == '__main__': - unittest.main() diff --git a/tests/test_create_build_adoc_include.py b/tests/test_create_build_adoc_include.py deleted file mode 100644 index ed33677d5..000000000 --- a/tests/test_create_build_adoc_include.py +++ /dev/null @@ -1,108 +0,0 @@ -#!/usr/bin/env python3 - -import os -import re -import subprocess -import shutil -import unittest -import json -import datetime - -# to run: on the command line, run all scripts from the top dir: pytest, -# or: python3 -m unittest tests.test_create_build_adoc_include - -class TestCreateBuildAdocInclude(unittest.TestCase): - def setUp(self): - script_path = os.path.realpath(__file__) - top_dir = re.sub(r"/tests/[^/]+$", "", script_path) - self.fixtures_path = os.path.join(top_dir, "tests", "fixtures") - self.script_path = os.path.join(top_dir, "scripts") - self.process_path = os.path.join(self.script_path, "create_build_adoc_include.py") - self.build_path = os.path.join(self.fixtures_path, "build") - self.output_path = os.path.join(self.build_path, "jekyll", "microcontrollers", "csdk") - self.output_file = os.path.join(self.output_path, "your_first_binary.adoc") - - def tearDown(self): - shutil.rmtree(self.build_path) - - def test_create_build_adoc_include(self): - os.makedirs(self.output_path) - config_yaml = os.path.join(self.fixtures_path, "_config.yml") - github_edit = os.path.join(self.fixtures_path, "github_edit.adoc") - src_adoc = os.path.join(self.fixtures_path, "microcontrollers", "c_sdk", "your_first_binary.adoc") - build_adoc = self.output_file - - subprocess.run(["python3", self.process_path, config_yaml, github_edit, src_adoc, build_adoc]) - expected = '''== Your First Binaries -[.edit-link] -Edit this {0}[on GitHub] - - - -WARNING: If you are using an Apple Mac, and running macOS Ventura, there has been a change in how the Finder works which causes drag-and-drop to fail. Please see our https://www.raspberrypi.com/news/the-ventura-problem/[blog post] for a full explanation, and workarounds, and our https://github.com/raspberrypi/pico-sdk/issues/1081[Github issue] tracking the problem for the current status. - -=== Blink an LED - -The first program anyone writes when using a new microcontroller is to blink an LED on and off. The Raspberry Pi Pico comes with a single LED on-board. The LED is connected to `GP25` on the board's Raspberry Pi RP2040 for Pico, and `WL_GPIO0` on the Infineon 43439 wireless chip for Pico W. - -image:images/Blink-an-LED-640x360-v2.gif[] - -You can blink this on and off by, - -. Download the Blink UF2 https://datasheets.raspberrypi.com/soft/blink.uf2[for Raspberry Pi Pico], or https://datasheets.raspberrypi.com/soft/blink_picow.uf2[for Pico W]. -. Push and hold the BOOTSEL button and plug your Pico into the USB port of your Raspberry Pi or other computer. -. It will mount as a Mass Storage Device called RPI-RP2. -. Drag and drop the Blink UF2 binary onto the RPI-RP2 volume. Pico will reboot. - -You should see the on-board LED blinking. - -You can see the code on Github for the https://github.com/raspberrypi/pico-examples/blob/master/blink/blink.c[Raspberry Pi Pico] and https://github.com/raspberrypi/pico-examples/blob/master/pico_w/wifi/blink/picow_blink.c[Pico W] versions. - -=== Say "Hello World" - -The next program anyone writes is to say 'Hello World' over a USB serial connection. - -image:images/Hello-World-640x360-v2.gif[] - -. Download the https://datasheets.raspberrypi.com/soft/hello_world.uf2['Hello World' UF2]. -. Push and hold the BOOTSEL button and plug your Pico into the USB port of your Raspberry Pi or other computer. -. It will mount as a Mass Storage Device called RPI-RP2. -. Drag and drop the 'Hello World' UF2 binary onto the RPI-RP2 volume. Pico will reboot. -. Open a Terminal window and type: -+ -[source] ------- -sudo apt install minicom -minicom -b 115200 -o -D /dev/ttyACM0 ------- - -You should see 'Hello, world!' printed to the Terminal. - -You can see the code https://github.com/raspberrypi/pico-examples/blob/master/hello_world/usb/hello_usb.c[on Github] -'''.format(os.path.join(self.fixtures_path, "microcontrollers", "c_sdk", "your_first_binary.adoc")) - res = "" - if os.path.isfile(self.output_file): - with open(self.output_file) as f: - res = f.read() - self.assertTrue(expected == res) - -def run_create_build_adoc_include_tests(event, context): - suite = unittest.defaultTestLoader.loadTestsFromTestCase(TestCreateBuildAdocInclude) - result = unittest.TextTestRunner(verbosity=2).run(suite) - if result.wasSuccessful(): - body = { "message": "Tests passed!" } - response = { - "statusCode": 200, - "body": json.dumps(body) - } - return response - else : - body = { "message": "Tests failed!" } - response = { - "statusCode": 500, - "body": json.dumps(body) - } - return response - -if __name__ == '__main__': - unittest.main() diff --git a/tests/test_create_nav.py b/tests/test_create_nav.py deleted file mode 100644 index 0a307048d..000000000 --- a/tests/test_create_nav.py +++ /dev/null @@ -1,103 +0,0 @@ -#!/usr/bin/env python3 - -import os -import re -import subprocess -import shutil -import unittest -import json -import datetime - -# to run: on the command line, run all scripts from the top dir: pytest, -# or: python3 -m unittest tests.test_create_nav - -# NOTE: This test is unfortunately not standalone -- it requires -# that you've run both make build_doxygen_adoc and make first. - -class TestCreateNav(unittest.TestCase): - def setUp(self): - script_path = os.path.realpath(__file__) - self.top_dir = re.sub(r"/tests/[^/]+$", "", script_path) - self.fixtures_path = os.path.join(self.top_dir, "tests", "fixtures") - self.script_path = os.path.join(self.top_dir, "scripts") - self.process_path = os.path.join(self.script_path, "create_nav.py") - self.build_path = os.path.join(self.fixtures_path, "build") - self.output_path = os.path.join(self.build_path, "jekyll", "_data") - self.output_file = os.path.join(self.output_path, "nav.json") - - def tearDown(self): - shutil.rmtree(self.build_path) - - def test_create_nav(self): - os.makedirs(self.output_path) - index_json = os.path.join(self.fixtures_path, "build_jekyll_data_index.json") - adoc_dir = os.path.join(self.fixtures_path) - output_json = self.output_file - - subprocess.run(["python3", self.process_path, index_json, adoc_dir, output_json]) - expected = r'''[ - { - "title": "Microcontrollers", - "path": "/microcontrollers/", - "toc": [ - { - "path": "/microcontrollers/c_sdk.html", - "title": "The C/C++ SDK", - "sections": [ - { - "heading": "SDK Setup", - "anchor": "sdk-setup" - }, - { - "heading": "Raspberry Pi Pico C/{cpp} SDK", - "anchor": "raspberry-pi-pico-ccpp-sdk" - }, - { - "heading": "Your First Binaries", - "anchor": "your-first-binaries", - "subsections": [ - { - "heading": "Blink an LED", - "anchor": "blink-an-led" - }, - { - "heading": "Say \"Hello World\"", - "anchor": "say-hello-world" - } - ] - }, - { - "heading": "Quick-start your own project", - "anchor": "quick-start-your-own-project" - } - ] - } - ] - } -]''' - res = "" - if os.path.isfile(self.output_file): - with open(self.output_file) as f: - res = f.read() - self.assertTrue(expected == res) - -def run_create_nav_tests(event, context): - suite = unittest.defaultTestLoader.loadTestsFromTestCase(TestCreateNav) - result = unittest.TextTestRunner(verbosity=2).run(suite) - if result.wasSuccessful(): - body = { "message": "Tests passed!" } - response = { - "statusCode": 200, - "body": json.dumps(body) - } - return response - else : - body = { "message": "Tests failed!" } - response = { - "statusCode": 500, - "body": json.dumps(body) - } - return response - -if __name__ == '__main__': - unittest.main()