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

Fixes formatting issues in the `command list` section.
apache · Sep 26, 2024 · a316d3d · a316d3d
1 parent 0c237bf
commit a316d3d
Show file tree

Hide file tree

Showing 10 changed files with 218 additions and 184 deletions.
diff --git a/docs/command_list/newt_build.rst b/docs/command_list/newt_build.rst
@@ -33,10 +33,13 @@ You can specify a list of target names, separated by a space, to build multiple
 Examples
 ^^^^^^^^
 
-+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Usage | Explanation |
-+====================================+================================================================================================================================================================================================================================================================+
-| ``newt build my_blinky_sim`` | Builds an executable for the ``my_blinky_sim`` target. For example, if the ``my_blinky_sim`` target has ``app`` set to ``apps/blinky``, you will find the generated .elf, .a, and .lst files in the 'bin/targets/my\_blinky\_sim/app/apps/blinky' directory. |
-+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ``newt build my_blinky_sim myble`` | Builds the images for the applications defined by the ``my_blinky_sim`` and ``myble`` targets. |
-+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+.. tabularcolumns:: |l|p{10cm}|
+.. table::
+
+ +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Usage | Explanation |
+ +====================================+================================================================================================================================================================================================================================================================+
+ | ``newt build my_blinky_sim`` | Builds an executable for the ``my_blinky_sim`` target. For example, if the ``my_blinky_sim`` target has ``app`` set to ``apps/blinky``, you will find the generated .elf, .a, and .lst files in the 'bin/targets/my\_blinky\_sim/app/apps/blinky' directory. |
+ +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``newt build my_blinky_sim myble`` | Builds the images for the applications defined by the ``my_blinky_sim`` and ``myble`` targets. |
+ +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
diff --git a/docs/command_list/newt_clean.rst b/docs/command_list/newt_clean.rst
@@ -31,12 +31,15 @@ Deletes all the build artifacts generated for the ``target-name`` target. It doe
 Examples
 ^^^^^^^^
 
-+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Usage | Explanation |
-+====================================+==========================================================================================================================================================================================+
-| ``newt clean myble`` | Deletes the 'bin/targets/myble' directory where all the build artifacts generated from the ``myble`` target build are stored. |
-+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ``newt clean my_blinky_sim myble`` | Deletes the 'bin/targets/my\_blinky\_sim' and the 'bin/targets/myble' directories where all the artifacts generated from the ``my_blinky_sim`` and ``myble`` target builds are stored. |
-+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ``newt clean all`` | Removes the artifacts for all target builds. Deletes the top level 'bin' directory. |
-+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+.. tabularcolumns:: |l|p{10cm}|
+.. table::
+
+ +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Usage | Explanation |
+ +====================================+==========================================================================================================================================================================================+
+ | ``newt clean myble`` | Deletes the 'bin/targets/myble' directory where all the build artifacts generated from the ``myble`` target build are stored. |
+ +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``newt clean my_blinky_sim myble`` | Deletes the 'bin/targets/my\_blinky\_sim' and the 'bin/targets/myble' directories where all the artifacts generated from the ``my_blinky_sim`` and ``myble`` target builds are stored. |
+ +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``newt clean all`` | Removes the artifacts for all target builds. Deletes the top level 'bin' directory. |
+ +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
diff --git a/docs/command_list/newt_create_image.rst b/docs/command_list/newt_create_image.rst
@@ -33,25 +33,28 @@ To sign an image, provide a .pem file for the ``signing-key`` and an optional ``
 Examples
 ^^^^^^^^
 
-================================================== =================================================================================
-Usage Explanation
-================================================== =================================================================================
-``newt create-image myble2 1.0.1.0`` Creates an image for target ``myble2`` and assigns it version
- ``1.0.1.0``.
-
- For the following target definition:
-
- | targets/myble2
- | app=\@apache-mynewt-core/apps/btshell
- | bsp=\@apache-mynewt-core/hw/bsp/nrf52dk
- | build\_profile=optimized
- | syscfg=STATS\_NAMES=1
-
- the 'bin/targets/myble2/app/apps/btshell/btshell.img' and
- 'bin/targets/myble2/app/apps/btshell/btshell.hex' files are created,
- and the manifest in 'bin/targets/myble2/app/apps/btshell/manifest.json'
- is updated with the image information.
-
-``newt create-image myble2 1.0.1.0 private.pem`` Creates an image for target ``myble2`` and assigns it the version
- ``1.0.1.0``. Signs the image using private key specified by the private.pem file.
-================================================== =================================================================================
+.. tabularcolumns:: |l|p{7.2cm}|
+.. table::
+
+ ================================================== =================================================================================
+ Usage Explanation
+ ================================================== =================================================================================
+ ``newt create-image myble2 1.0.1.0`` Creates an image for target ``myble2`` and assigns it version
+ ``1.0.1.0``.
+
+ For the following target definition:
+
+ | targets/myble2
+ | app=\@apache-mynewt-core/apps/btshell
+ | bsp=\@apache-mynewt-core/hw/bsp/nrf52dk
+ | build\_profile=optimized
+ | syscfg=STATS\_NAMES=1
+
+ the 'bin/targets/myble2/app/apps/btshell/btshell.img' and
+ 'bin/targets/myble2/app/apps/btshell/btshell.hex' files are created,
+ and the manifest in 'bin/targets/myble2/app/apps/btshell/manifest.json'
+ is updated with the image information.
+
+ ``newt create-image myble2 1.0.1.0 private.pem`` Creates an image for target ``myble2`` and assigns it the version
+ ``1.0.1.0``. Signs the image using private key specified by the private.pem file.
+ ================================================== =================================================================================
diff --git a/docs/command_list/newt_debug.rst b/docs/command_list/newt_debug.rst
@@ -39,10 +39,13 @@ Opens a debugger session to the image built for the <target-name> target.
 Examples
 ^^^^^^^^
 
-+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Usage | Explanation |
-+==========================+============================================================================================================================================================================================================================================================================================+
-| ``newt debug myble2`` | Opens a J-Link connection and starts a GNU gdb session to debug bin/targets/myble2/app/apps/btshell/btshell.elf when the target is as follows: targets/myble2 app=\@apache-mynewt-core/apps/btshell bsp=\@apache-mynewt-core/hw/bsp/nrf52dk build_profile=optimized syscfg=STATS_NAMES=1 |
-+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ``newt debug myble2 -n`` | Opens a J-Link connection bin/targets/myble2/app/apps/btshell/btshell.elf but do not start GDB on the command line. |
-+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+.. tabularcolumns:: |l|p{12cm}|
+.. table::
+
+ +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Usage | Explanation |
+ +==========================+============================================================================================================================================================================================================================================================================================+
+ | ``newt debug myble2`` | Opens a J-Link connection and starts a GNU gdb session to debug bin/targets/myble2/app/apps/btshell/btshell.elf when the target is as follows: targets/myble2 app=\@apache-mynewt-core/apps/btshell bsp=\@apache-mynewt-core/hw/bsp/nrf52dk build_profile=optimized syscfg=STATS_NAMES=1 |
+ +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``newt debug myble2 -n`` | Opens a J-Link connection bin/targets/myble2/app/apps/btshell/btshell.elf but do not start GDB on the command line. |
+ +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+