docs: Fix the layout in multiple .rst files for the PDF output

Fixes formatting issues in the following categories: - Tutorials - External Links
apache · Sep 26, 2024 · 79cf826 · 79cf826
1 parent 8ffe9da
commit 79cf826
Show file tree

Hide file tree

Showing 12 changed files with 38 additions and 40 deletions.
diff --git a/docs/external_links.rst b/docs/external_links.rst
@@ -10,15 +10,6 @@ This page lists links to information, tutorial, articles, and posts on Apache My
 Helpful Tutorials and Tools
 ---------------------------
 
-- |sensor_app_link| : A detailed step-by-step guide on how to build your IoT Sensor Network using STM32 Blue Pill, nRF24L01, ESP8266, thethings.io, and Apache Mynewt. 
-
-.. |sensor_app_link| raw:: html
-
-   <a href="https://medium.com/@ly.lee/build-your-iot-sensor-network-stm32-blue-pill-nrf24l01-esp8266-apache-mynewt-thethings-io-ca7486523f5d" target="_blank">Sensor app and network tutorial</a>
-
-- |ubuntu_vbox_link| : An Ubuntu VirtualBox with the complete Mynewt 1.6.0 source code + build tools for STM32 Blue Pill to go with the tutorial above. `
-
-.. |ubuntu_vbox_link| raw:: html
-
-   <a href="https://github.com/lupyuen/stm32bluepill-mynewt-sensor/releases/tag/v1.0.0" target="_blank">Ubuntu VirtualBox with Source Code and Build Tools</a>
+- `Sensor app and network tutorial: <https://lupyuen.github.io/articles/build-your-iot-sensor-network-stm32-blue-pill-nrf24l01-esp8266-apache-mynewt-thethings-io>`_  A detailed step-by-step guide on how to build your IoT Sensor Network using STM32 Blue Pill, nRF24L01, ESP8266, thethings.io, and Apache Mynewt.
 
+- `Ubuntu VirtualBox with Source Code and Build Tools: <https://github.com/lupyuen/stm32bluepill-mynewt-sensor/releases/tag/v1.0.0>`_ An Ubuntu VirtualBox with the complete Mynewt 1.6.0 source code + build tools for STM32 Blue Pill to go with the tutorial above.
diff --git a/docs/tutorials/blinky/blinky.rst b/docs/tutorials/blinky/blinky.rst
@@ -46,6 +46,7 @@ Tutorials are available for the following boards:
 -  :doc:`rbnano2`
 -  :doc:`blinky_stm32f4disc`
 -  :doc:`blinky_STM32F303`
+-  :doc:`blinky_pin-wheel-mods`
 
 We also have a tutorial that shows you how to add :doc:`blinky_console`.
 

diff --git a/docs/tutorials/blinky/blinky_STM32F303.rst b/docs/tutorials/blinky/blinky_STM32F303.rst
@@ -9,7 +9,7 @@ Mynewt to build your first *Hello World* application (Blinky) on a
 target board. Once built using the *newt* tool, this application will
 blink the LED lights on the target board.
 
-Create a project with a simple app that blinks an LED on the stmf303
+Create a project with a simple app that blinks an LED on the STM F303
 discovery board. In the process import some external libraries into your
 project. Download the application to the target and watch it blink!
 
@@ -20,7 +20,7 @@ What you need
 -  Laptop running Mac OSX.
 -  It is assumed you have already installed newt tool.
 -  It is assumed you already installed native tools as described
-   `here <../get_started/native_tools.html>`__
+   :doc:`here <../../get_started/native_install/native_tools>`
 
 Also, we assume that you're familiar with UNIX shells. Let's gets
 started!
@@ -29,8 +29,8 @@ Create a project
 ~~~~~~~~~~~~~~~~
 
 Create a new project to hold your work. For a deeper understanding, you
-can read about project creation in `Get Started -- Creating Your First
-Project <../get_started/project_create.html>`__ or just follow the
+can read about project creation in :doc:`Get Started -- Creating Your First
+Project <../../get_started/project_create>` or just follow the
 commands below.
 
 If you've already created a project from another tutorial, you can
@@ -168,16 +168,14 @@ Want more?
 
 Want to make your board do something a little more exciting with the
 LEDs? Then try making the modifications to the Blinky app to make it a
-`pin-wheel app <pin-wheel-mods.html>`__ and you can light all the LEDs in
+:doc:`pin wheel app <blinky_pin-wheel-mods>` and you can light all the LEDs in
 a pin-wheel fashion.
 
 We have more fun tutorials for you to get your hands dirty. Be bold and
-try other Blinky-like `tutorials <../tutorials/nRF52.html>`__ or try
-enabling additional functionality such as `remote
-comms <project-slinky.html>`__ on the current board.
+try other Blinky-like :doc:`tutorials <nRF52>` or try
+enabling additional functionality such as :doc:`remote comms <../slinky/project-slinky>` on the current board.
 
 If you see anything missing or want to send us feedback, please do so by
-signing up for appropriate mailing lists on our `Community
-Page <../../community.html>`__.
+signing up for appropriate mailing lists on our `Community Page </community>`_
 
 Keep on hacking and blinking!
diff --git a/docs/tutorials/blinky/blinky_pin-wheel-mods.rst b/docs/tutorials/blinky/blinky_pin-wheel-mods.rst
@@ -5,7 +5,7 @@ Objective
 ~~~~~~~~~~~~~~~
 
 
-Learn how to modify an existing app -- the `blinky <STM32F303.html>`__ app
+Learn how to modify an existing app -- the :doc:`blinky <blinky_STM32F303>` app
 -- to light all the LEDs on the STM32F3 Discovery board.
 
 What you need
@@ -14,7 +14,7 @@ What you need
 -  Discovery kit with STM32F303VC MCU
 -  Laptop running Mac OSX.
 -  It is assumed you have already installed and run the
-   `blinky <STM32F303.html>`__ app succesfully.
+   :doc:`blinky <blinky_STM32F303>` app succesfully.
 
 Since you've already successfully created your blinky app project,
 you'll need to modify only one file, main.c, in order to get this app
@@ -100,7 +100,6 @@ all lit, they should then go off in the same order. This should repeat
 continuously.
 
 If you see anything missing or want to send us feedback, please do so by
-signing up for appropriate mailing lists on our `Community
-Page <../../community.html>`__.
+signing up for appropriate mailing lists on our `Community Page </community>`_.
 
 Keep on hacking and blinking!
diff --git a/docs/tutorials/os_fundamentals/tasks_lesson.rst b/docs/tutorials/os_fundamentals/tasks_lesson.rst
@@ -317,6 +317,7 @@ expect when we set the ``work_task`` priority higher and lower than the
 
 .. figure:: ../pics/task_lesson.png
    :alt: Task Scheduling
+   :width: 360
 
    Task Scheduling
 

diff --git a/docs/tutorials/sensors/air_quality_sensor.rst b/docs/tutorials/sensors/air_quality_sensor.rst
@@ -734,13 +734,15 @@ Here's what your SenseAir board should look like once it's wired up:
 
 .. figure:: ../pics/K30labeled.JPG
    :alt: SenseAir Wiring
+   :width: 500
 
    SenseAir Wiring
 
-Now that you have that wired up, let's connect it to the nRF52DK board. Since we will be using the built-in UART, we can simply connect it to the pre-configured pins for TX (P.06) and RX (P.08). Here's what your board should look like once everything is connected: 
+Now that you have that wired up, let's connect it to the nRF52DK board. Since we will be using the built-in UART, we can simply connect it to the pre-configured pins for TX (P.06) and RX (P.08). Here's what your board should look like once everything is connected:
 
 .. figure:: ../pics/nrf52labeled.JPG
    :alt: SenseAir and nRF52DK Wiring
+   :width: 500
 
    SenseAir and nRF52DK Wiring
 

diff --git a/docs/tutorials/sensors/sensor_bleprph_oic.rst b/docs/tutorials/sensors/sensor_bleprph_oic.rst
@@ -325,11 +325,13 @@ from the Android App:
 
 .. image:: ../pics/smart_controller_main.png
    :align: center
+   :width: 270
 
 1. Select ``Accelerometer`` to see the sensor data samples:
 
 .. image:: ../pics/smart_controller_accelerometer.png
    :align: center
+   :width: 270
 
 2. Move your BNO055 sensor device around to see the values for the
 coordinates change.
diff --git a/docs/tutorials/sensors/sensor_nrf52_bno055.rst b/docs/tutorials/sensors/sensor_nrf52_bno055.rst
@@ -126,9 +126,7 @@ the following syscfg settings enabled:
 commands. The ``SENSOR_CLI`` setting, that specifies whether the
 ``sensor`` shell command is enabled, is enabled by default.
 
-1. Run the ``newt target create`` command, from your project base
-directory, to create the target. We name the target
-``nrf52_bno055_test``:
+1. Run the ``newt target create`` command, from your project base directory, to create the target. We name the target ``nrf52_bno055_test``:
 
 .. code-block:: console
 
@@ -137,8 +135,7 @@ directory, to create the target. We name the target
     Target targets/nrf52_bno055_test successfully created
     $
 
-2. Run the ``newt target set`` command to set the app, bsp, and
-build\_profile variables for the target:
+2. Run the ``newt target set`` command to set the app, bsp, and build\_profile variables for the target:
 
 .. code-block:: console
 
@@ -150,8 +147,7 @@ build\_profile variables for the target:
 
     $
 
-3. Run the ``newt target set`` command to enable the ``I2C_0``,
-``BNO055_OFB``, and ``BBNO055_CLI`` syscfg settings:
+3. Run the ``newt target set`` command to enable the ``I2C_0``,  ``BNO055_OFB``, and ``BBNO055_CLI`` syscfg settings:
 
 .. code-block:: console
 
@@ -201,8 +197,7 @@ Step 3: Building the Bootloader and Application Image
     Linking ~/dev/myproj/bin/targets/nrf52_boot/app/boot/mynewt/mynewt.elf
     Target successfully built: targets/nrf52_boot
 
-2. Run the ``newt build nrf52_bno055_test`` command to build the
-sensors\_test application:
+2. Run the ``newt build nrf52_bno055_test`` command to build the sensors\_test application:
 
 .. code-block:: console
 
@@ -285,8 +280,7 @@ Step 6: Connecting the nRF52-DK Board to your Computer
    board to power the board and to load the bootloader and application
    image.
 
-2. Turn the power on the board to ON. You should see the green LED
-light up on the board.
+2. Turn the power on the board to ON. You should see the green LED light up on the board.
 
 Step 7: Loading the Bootloader and the Application Image
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -300,8 +294,7 @@ Step 7: Loading the Bootloader and the Application Image
     Loading bootloader
     $
 
-2. Run the ``newt load nrf52_bno055_test`` command to load the
-application image on to the board:
+2. Run the ``newt load nrf52_bno055_test`` command to load the application image on to the board:
 
 .. code-block:: console
 
@@ -578,4 +571,7 @@ with a sensor, We recommend that you:
    Overview <sensors>`
 
 .. |Alt Layout - BNO055| image:: ../pics/BNO055_small.jpg
+   :height: 350
+
 .. |Alt Layout - NRF52_I2C| image:: ../pics/NRF52_I2C_small.jpg
+   :height: 350
diff --git a/docs/tutorials/sensors/sensor_nrf52_bno055_oic.rst b/docs/tutorials/sensors/sensor_nrf52_bno055_oic.rst
@@ -125,11 +125,13 @@ from the Android App:
 
 .. image:: ../pics/smart_controller_main.png
    :align: center
+   :width: 300
 
 1. Select ``Accelerometer`` to see the sensor data samples:
 
 .. image:: ../pics/smart_controller_accelerometer.png
    :align: center
+   :width: 300
 
 2. Move your BNO055 sensor device around to see the values for the
    coordinates change.
diff --git a/docs/tutorials/sensors/sensor_nrf52_drv2605.rst b/docs/tutorials/sensors/sensor_nrf52_drv2605.rst
@@ -57,7 +57,7 @@ the following syscfg settings enabled:
    the driver.
 
 -  ``DRV2605_EN_PIN``: The pin the driver needs to gpio in order to enable
-    your DRV2605 device.
+   your DRV2605 device.
 
 -  ``DRV2605_RATED_VOLTAGE``: I have no easy default for you here, it is 
    entirelay based on your purchased LRA motor. See 8.5.2.1 Rated Voltage

diff --git a/docs/tutorials/sensors/sensor_thingy_lis2dh12_onb.rst b/docs/tutorials/sensors/sensor_thingy_lis2dh12_onb.rst
@@ -774,4 +774,7 @@ You should see the accelerometer sensor data output from the sensor read
 data callback.
 
 .. |Thingy| image:: ../pics/thingy.jpg
+   :width: 320
+
 .. |J-Link debug probe to Thingy| image:: ../pics/thingy_jlink.jpg
+   :width: 320
diff --git a/docs/tutorials/tooling/segger_sysview.rst b/docs/tutorials/tooling/segger_sysview.rst
@@ -80,12 +80,15 @@ Launch the app
 Launch the app and press **OK** in the System Information dialog box.
 
 .. figure:: ../pics/segger_sysview1.png
+   :width: 350
 
 Select **Target > Start Recording** and press **OK** in the
 Configuration dialog box.
 
 .. figure:: ../pics/segger_sysview_start_record.png
+   :width: 350
 
 You should see the recording for your Mynewt application.
 
 .. figure:: ../pics/segger_sysview_recording.png
+   :width: 320