[FIX] *: RST cleanup

RST cleanup to comply with the RST guidelines. This is required so we can use "make test", as there are currently hundreds of errors. For now, it is unusable because of the oldest code in this repo. closes odoo/documentation#3568 Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-13 15:50:13 +00:00
parent 295d29effd
commit c5434ccd0a
65 changed files with 731 additions and 738 deletions
@@ -18,18 +18,18 @@ Follow the steps to connect your IoT Box.
   :align: center

 Ethernet Connection
-~~~~~~~~~~~~~~~~~~~
+===================

-1. Connect to the IoT Box all the devices that have to be connected with
+#. Connect to the IoT Box all the devices that have to be connected with
   cables (ethernet, usb devices, etc.).

-2. Power on the IoT Box.
+#. Power on the IoT Box.

-3. Read the Pairing Code from a screen or a receipt printer connected to the IoT Box.
+#. Read the Pairing Code from a screen or a receipt printer connected to the IoT Box.

   .. image:: connect/connect04.png

-4. Input the Pairing Code and click on the Pair button.
+#. Input the Pairing Code and click on the Pair button.

 .. note::
   Recent changes in modern web browsers forced us to modify the connection wizard.
@@ -37,20 +37,20 @@ Ethernet Connection
   ``iot_pairing`` module is installed.

 WiFi Connection
-~~~~~~~~~~~~~~~
+===============

-1. Power on the IoT Box
+#. Power on the IoT Box

-2. Copy the token
+#. Copy the token

   .. image:: connect/connect05.png

-3. Connect to the IoT Box WiFi Network (make sure there is no ethernet
+#. Connect to the IoT Box WiFi Network (make sure there is no ethernet
   cable plugged in your computer).

   .. image:: connect/connect06.png

-4. You will be redirected to the IoT Box Homepage (if it doesn't work,
+#. You will be redirected to the IoT Box Homepage (if it doesn't work,
   connect to the IP address of the box). Give a name to your IoT Box (not
   required) and paste the token, then click on next.

@@ -63,7 +63,7 @@ WiFi Connection
      should become
      **http://375228-saas-11-5-iot-f3f920-all.runbot16.odoo.com\|4957098401**).

-5. Choose the WiFi network you want to connect with (enter the password
+#. Choose the WiFi network you want to connect with (enter the password
   if there is one) and click on Submit. Wait a few seconds before being
   redirected to your database.

@@ -75,7 +75,7 @@ You should now see the IoT Box.
   :align: center

 IoT Box Schema
-~~~~~~~~~~~~~~
+==============

 .. image:: connect/connect10.png
   :align: center
@@ -3,10 +3,10 @@ Use the IoT Box for the PoS
 ===========================

 .. image:: pos/pos01.png
-    :align: center
+   :align: center

 Prerequisites
-~~~~~~~~~~~~~
+=============

 Before starting, make sure you have the following:

@@ -27,7 +27,7 @@ Before starting, make sure you have the following:
   page <https://www.odoo.com/page/point-of-sale-hardware>`__

 Set Up
-~~~~~~~
+======

 To connect hardware to the PoS, the first step is to connect an IoT Box
 to your database. For this, follow this
@@ -62,6 +62,6 @@ and select the devices you want to use in this Point of Sale. Save the
 changes.

 .. image:: pos/pos02.png
-    :align: center
+   :align: center

 Set up is done, you can launch a new PoS Session.
@@ -6,7 +6,7 @@ IoT Box Connection
 ==================

 I can't find the pairing code to connect my IoT Box
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+---------------------------------------------------

 The pairing code should be printed on receipt printers connected to the
 IoT Box and should also be displayed on connected monitors.
@@ -30,7 +30,7 @@ has correctly started, by checking that a fixed green LED is showing next to
 the micro-USB port.

 I've connected my IoT Box but it's not showing in my database
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-------------------------------------------------------------

 When you connect an IoT Box to a database, the IoT Box might restart, if
 that is the case, it might take up to one minute before appearing in your
@@ -39,7 +39,7 @@ your database can be reached from the IoT Box and that your server doesn't
 use a multi-database environment.

 My IoT Box is connected to my database, but cannot be reached
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-------------------------------------------------------------

 Make sure that the IoT Box and the device running the browser are located
 on the same network as the IoT Box cannot be reached from outside the local
@@ -49,7 +49,7 @@ Printer
 =======

 My printer is not detected
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+--------------------------

 If one of your printers doesn't show up in your devices list, go to the
 IoT Box homepage and make sure that it is listed under *Printers*.
@@ -63,7 +63,7 @@ If your printer is not present on the IoT Box homepage, hit
 not connected properly.

 My printer outputs random text
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------------

 For most printers, the correct driver should be automatically detected
 and selected. However, in some cases, the automatic detection mechanism
@@ -85,7 +85,7 @@ corresponding to your printer.
   printers.

 My Zebra Printer doesn't print anything
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+---------------------------------------

 Zebra printers are quite sensitive to the format of the ZPL code that is
 printed. If nothing comes out of the printer or blank labels are printed,
@@ -97,7 +97,7 @@ Barcode Scanner
 ===============

 The characters read by the barcode scanner don't match the barcode
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------------------------------------------------

 By default, we assume that your barcode scanner is configured in US
 QWERTY. This is the default configuration of most barcode readers.
@@ -105,14 +105,14 @@ If your barcode scanner uses a different layout, please go to the
 form view of your device and select the correct one.

 Nothing happens when a barcode is scanned
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-----------------------------------------

 Make sure that the correct device is selected in your Point of Sale
 configuration and that your barcode is configured to send an ENTER
 character (keycode 28) at the end of every barcode.

 The barcode scanner is detected as a keyboard
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+---------------------------------------------

 Some poorly built barcode scanners do not advertise themselves as
 barcode scanners but as a USB keyboard instead, and will not be
@@ -128,7 +128,7 @@ Cashdrawer
 ==========

 The cashdrawer does not open
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+----------------------------

 The cashdrawer should be connected to the printer and the *Cashdrawer*
 checkbox should be ticked in the POS configuration.
@@ -10,9 +10,8 @@ connected, the screen can be used to display a :abbr:`PoS (Point of Sale)` order
   :alt: An example of a PoS (point of sale) order on a screen display.

 .. note::
-   Access the customer display from any other computer by going to the :abbr:`IoT (Internet of Things)`
-   Box homepage and clicking on the :guilabel:`POS Display` button.
-
+   Access the customer display from any other computer by going to the :abbr:`IoT (Internet of
+   Things)` Box homepage and clicking on the :guilabel:`POS Display` button.

 Connection
 ==========
@@ -24,21 +23,22 @@ on the model.

   .. tab:: IoT Box model 4

-      Connect up to two screens with Micro-HDMI cables on the side of the :abbr:`IoT (Internet of Things)`
-      Box. If two screens are connected, they can display distinct content (see usage below).
+      Connect up to two screens with Micro-HDMI cables on the side of the :abbr:`IoT (Internet of
+      Things)` Box. If two screens are connected, they can display distinct content (see usage
+      below).

   .. tab:: IoT Box model 3

      Connect the screen with an HDMI cable on the side of the :abbr:`IoT (Internet of Things)` Box.

 .. important::
-   Screen(s) should be connected before the :abbr:`IoT (Internet of Things)` Box is switched on. If it
-   is already on, connect the screen(s), and then restart the :abbr:`IoT (Internet of Things)` Box by
-   unplugging it and plugging it back into its power source.
+   Screen(s) should be connected before the :abbr:`IoT (Internet of Things)` Box is switched on. If
+   it is already on, connect the screen(s), and then restart the :abbr:`IoT (Internet of Things)`
+   Box by unplugging it and plugging it back into its power source.

 .. warning::
-   The usage of HDMI/Micro-HDMI adapters may cause issues which will result in a blank, black screen on
-   the screen display. Cable usage is recommended.
+   The usage of HDMI/Micro-HDMI adapters may cause issues which will result in a blank, black screen
+   on the screen display. Cable usage is recommended.

 If the connection was successful, the screen should display the :guilabel:`POS Client display`
 screen.
@@ -56,7 +56,8 @@ Things)` Box homepage.
   :alt: An example of a screen display name shown on the IoT Box homepage.

 .. note::
-    If no screen is detected, a default display named :guilabel:`Distant Display` will be used instead.
+   If no screen is detected, a default display named :guilabel:`Distant Display` will be used
+   instead.

    .. image:: screen/screen-no-screen.png
       :align: center
@@ -66,7 +67,7 @@ Usage
 =====

 Show Point of Sales orders to customers
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+---------------------------------------

 To use the screen in the :guilabel:`Point of Sale` app, go to :menuselection:`Point of Sale -->
 Configuration --> Point of Sale`, open the desired screen, click on :guilabel:`Edit`, and enable the
@@ -84,17 +85,18 @@ in the top bar to inform the connection status with the screen.

    .. image:: screen/screen-pos-icon.png
       :align: center
-       :alt: The "screen" icon on the Point of Sale display shows the connection status with the screen.
+       :alt: The "screen" icon on the Point of Sale display shows the connection status with the
+             screen.

-The screen will automatically show the :abbr:`PoS (Point of Sale)` orders and update when changes are
-performed on the order.
+The screen will automatically show the :abbr:`PoS (Point of Sale)` orders and update when changes
+are performed on the order.

 .. image:: screen/screen-pos-client-display.png
   :align: center
   :alt: An example of a PoS order on a screen display.

 Display a website
-~~~~~~~~~~~~~~~~~
+-----------------

 Opening the screen form view at :menuselection:`IoT --> Devices --> (screen device)` allows the user
 to choose a particular website URL to display on the screen with the :guilabel:`Screen URL` field.