From ad5d23e14e2e907356392d0571760bafe72f468a Mon Sep 17 00:00:00 2001 From: Deepak Khatri <lorforlinux@beagleboard.org> Date: Fri, 1 Dec 2023 22:47:00 +0530 Subject: [PATCH] Fix warnings Fix some code, code-block, and literalinclude warnings --- boards/beaglebone/ai-64/04-expansion.rst | 6 +++--- boards/beaglev/ahead/04-expansion.rst | 4 ++-- boards/beaglev/fire/05-demos.rst | 1 + .../demos-and-tutorials/gateware/gateware-full-flow.rst | 2 ++ .../gateware/gateware-tcl-scripts-structure.rst | 2 ++ boards/capes/cape-interface-spec.rst | 2 +- books/beaglebone-cookbook/02sensors/sensors.rst | 2 +- books/beaglebone-cookbook/04motors/motors.rst | 1 + 8 files changed, 13 insertions(+), 7 deletions(-) diff --git a/boards/beaglebone/ai-64/04-expansion.rst b/boards/beaglebone/ai-64/04-expansion.rst index cfff04f2..dac7baaa 100644 --- a/boards/beaglebone/ai-64/04-expansion.rst +++ b/boards/beaglebone/ai-64/04-expansion.rst @@ -65,7 +65,7 @@ Each row includes the gpiochipX and pinY in the format of `X Y`. You can use these values to directly control the GPIO pins with the commands shown below. -.. code:: +.. code:: bash # to set the GPIO pin state to HIGH debian@BeagleBone:~$ gpioset X Y=1 @@ -793,7 +793,7 @@ Each row includes the gpiochipX and pinY in the format of `X Y`. You can use these values to directly control the GPIO pins with the commands shown below. -.. code:: +.. code:: bash # to set the GPIO pin state to HIGH debian@BeagleBone:~$ gpioset X Y=1 @@ -2179,7 +2179,7 @@ RANDOM PRU STUFF THAT MIGHT NEED A HOME BeagleBone AI-64 and on which connector and pins they are accessible from. Some signals are accessible on the same pins. -.. _table-11,Table 11: +.. _table-11: .. list-table:: PRU0 and PRU1 Access :header-rows: 1 diff --git a/boards/beaglev/ahead/04-expansion.rst b/boards/beaglev/ahead/04-expansion.rst index 4f0159f9..009f0ab0 100644 --- a/boards/beaglev/ahead/04-expansion.rst +++ b/boards/beaglev/ahead/04-expansion.rst @@ -38,7 +38,7 @@ Each row includes the gpiochipX and pinY in the format of `X Y`. You can use these values to directly control the GPIO pins with the commands shown below. -.. code:: +.. code:: bash # to set the GPIO pin state to HIGH debian@BeagleBone:~$ gpioset X Y=1 @@ -485,7 +485,7 @@ Each row includes the gpiochipX and pinY in the format of `X Y`. You can use these values to direcly control the GPIO pins with the commands shown below. -.. code:: +.. code:: bash # to set the GPIO pin state to HIGH debian@BeagleBone:~$ gpioset X Y=1 diff --git a/boards/beaglev/fire/05-demos.rst b/boards/beaglev/fire/05-demos.rst index 56b95dc0..c318c38c 100644 --- a/boards/beaglev/fire/05-demos.rst +++ b/boards/beaglev/fire/05-demos.rst @@ -19,3 +19,4 @@ Demos demos-and-tutorials/gateware/index demos-and-tutorials/gateware/how-to-find-out-whats-on-the-board demos-and-tutorials/gateware/gateware-full-flow + demos-and-tutorials/gateware/gateware-tcl-scripts-structure diff --git a/boards/beaglev/fire/demos-and-tutorials/gateware/gateware-full-flow.rst b/boards/beaglev/fire/demos-and-tutorials/gateware/gateware-full-flow.rst index e00bea74..7dd29678 100644 --- a/boards/beaglev/fire/demos-and-tutorials/gateware/gateware-full-flow.rst +++ b/boards/beaglev/fire/demos-and-tutorials/gateware/gateware-full-flow.rst @@ -1,3 +1,5 @@ +.. _beaglev-fire-gateware-full-build-flow: + Gateware Full Build Flow ######################## diff --git a/boards/beaglev/fire/demos-and-tutorials/gateware/gateware-tcl-scripts-structure.rst b/boards/beaglev/fire/demos-and-tutorials/gateware/gateware-tcl-scripts-structure.rst index 31c9bc75..c38cb154 100644 --- a/boards/beaglev/fire/demos-and-tutorials/gateware/gateware-tcl-scripts-structure.rst +++ b/boards/beaglev/fire/demos-and-tutorials/gateware/gateware-tcl-scripts-structure.rst @@ -1,3 +1,5 @@ +.. _beaglev-fire-gateware-tcl-scripts-structure: + Gateware TCL Scripts Structure ############################## diff --git a/boards/capes/cape-interface-spec.rst b/boards/capes/cape-interface-spec.rst index 2943bb15..beb41b18 100644 --- a/boards/capes/cape-interface-spec.rst +++ b/boards/capes/cape-interface-spec.rst @@ -490,7 +490,7 @@ Cape interface specification provides |I2C| controller device links for userspac |I2C| overlay example ===================== -.. code-block:: +.. code-block:: devicetree :linenos: :caption: Example device tree overlay to enable I2C driver :name: bone_cape_spec_i2c_example diff --git a/books/beaglebone-cookbook/02sensors/sensors.rst b/books/beaglebone-cookbook/02sensors/sensors.rst index ef9f0b66..521f9bd1 100644 --- a/books/beaglebone-cookbook/02sensors/sensors.rst +++ b/books/beaglebone-cookbook/02sensors/sensors.rst @@ -124,7 +124,7 @@ By default, it takes you to your home directory. Notice that the prompt has chan - Press ^S (Ctrl-S) to save the file. (You can also go to the File menu in VSC and select Save to save the file, but Ctrl-S is easier.) Even easier, VSC can be configured to autosave every so many seconds. - In the *bash* tab, enter the following commands: -.. code-block:: +.. code-block:: bash debian@beaglebone:beaglebone-cookbook/code/02sensors$ ./pushbutton.py data= 0 diff --git a/books/beaglebone-cookbook/04motors/motors.rst b/books/beaglebone-cookbook/04motors/motors.rst index 0879e86c..d28b0465 100644 --- a/books/beaglebone-cookbook/04motors/motors.rst +++ b/books/beaglebone-cookbook/04motors/motors.rst @@ -143,6 +143,7 @@ Combine the code from :ref:`digital_rotaryEncoder_js` and :ref:`motors_servo`. .. _py_servoEncoder_code: .. literalinclude:: ../code/04motors/servoEncoder.py + :language: python :caption: Code for driving a servo motor with a rotary encorder(servoEncoder.py) :linenos: -- GitLab