Skip to content

Commit

Permalink
Merge pull request #3981 from raspberrypi/develop
Browse files Browse the repository at this point in the history
Release to production
  • Loading branch information
nathan-contino authored Dec 13, 2024
2 parents 0d4117e + 7c2d655 commit 4fbe29f
Show file tree
Hide file tree
Showing 138 changed files with 31 additions and 1,357 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Binary file modified documentation/asciidoc/accessories/ai-kit/images/ai-kit.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Binary file modified documentation/asciidoc/accessories/audio/images/Chatter_Box.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/asciidoc/accessories/audio/images/dac_plus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/asciidoc/accessories/audio/images/wiring.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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]
====
Expand Down
6 changes: 3 additions & 3 deletions documentation/asciidoc/accessories/build-hat/py-motors.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Binary file modified documentation/asciidoc/accessories/camera/images/FILTER_OFF.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/asciidoc/accessories/camera/images/FILTER_ON.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/asciidoc/accessories/camera/images/FLATLAY.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/asciidoc/accessories/camera/images/SOLVENT.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/asciidoc/accessories/camera/images/m12-lens.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/asciidoc/accessories/camera/images/resistor.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/asciidoc/accessories/display/images/display.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
2 changes: 1 addition & 1 deletion documentation/asciidoc/computers/ai/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Diff not rendered.
Diff not rendered.
Binary file modified documentation/asciidoc/computers/compute-module/images/cm4s.jpg
4 changes: 2 additions & 2 deletions documentation/asciidoc/computers/getting-started/install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
Binary file modified documentation/asciidoc/computers/raspberry-pi/images/500.png
Binary file modified documentation/asciidoc/computers/raspberry-pi/images/j5.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -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,

Expand All @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Diff not rendered.
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file not shown.
2 changes: 1 addition & 1 deletion documentation/asciidoc/microcontrollers/silicon/rp1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
14 changes: 2 additions & 12 deletions jekyll-assets/css/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down Expand Up @@ -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 */
Expand Down
17 changes: 13 additions & 4 deletions scripts/create_auto_ninjabuild.py
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Expand Down
54 changes: 0 additions & 54 deletions tests/fixtures/_config.yml

This file was deleted.

42 changes: 0 additions & 42 deletions tests/fixtures/build_jekyll_data_index.json

This file was deleted.

2 changes: 0 additions & 2 deletions tests/fixtures/github_edit.adoc

This file was deleted.

Loading

0 comments on commit 4fbe29f

Please sign in to comment.