doc: remove references to python 2
authorRobin Jarry <robin.jarry@6wind.com>
Fri, 2 Oct 2020 15:47:53 +0000 (17:47 +0200)
committerDavid Marchand <david.marchand@redhat.com>
Mon, 5 Oct 2020 08:24:12 +0000 (10:24 +0200)
Python 2 support has now been dropped. Remove references to it in the
documentation.

Since all python scripts now have a proper shebang that calls python3,
execute the scripts directly without specifying the interpreter.

Sphinx version from most Linux distros is OK in 2020, do not encourage
people to break their system by installing with pip. Use the distros
official packages.

Signed-off-by: Robin Jarry <robin.jarry@6wind.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Kevin Laatz <kevin.laatz@intel.com>
doc/guides/conf.py
doc/guides/contributing/documentation.rst
doc/guides/howto/telemetry.rst
doc/guides/nics/virtio.rst
doc/guides/rel_notes/deprecation.rst
doc/guides/tools/testbbdev.rst

index ef550f6..270754b 100644 (file)
@@ -22,7 +22,7 @@ try:
     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 except:
     print('Install the sphinx ReadTheDocs theme for improved html documentation '
-          'layout: pip install sphinx_rtd_theme')
+          'layout: https://sphinx-rtd-theme.readthedocs.io/')
     pass
 
 project = 'Data Plane Development Kit'
index 375ea64..be985e6 100644 (file)
@@ -164,14 +164,10 @@ For full support with figure and table captioning the latest version of Sphinx c
 .. code-block:: console
 
    # Ubuntu/Debian.
-   sudo apt-get -y install python-pip
-   sudo pip install --upgrade sphinx
-   sudo pip install --upgrade sphinx_rtd_theme
+   sudo apt-get -y install python3-sphinx python3-sphinx-rtd-theme
 
    # Red Hat/Fedora.
-   sudo dnf     -y install python-pip
-   sudo pip install --upgrade sphinx
-   sudo pip install --upgrade sphinx_rtd_theme
+   sudo dnf     -y install python3-sphinx python3-sphinx_rtd_theme
 
 For further information on getting started with Sphinx see the
 `Sphinx Getting Started <http://www.sphinx-doc.org/en/master/usage/quickstart.html>`_.
index e7b5434..cf73dc4 100644 (file)
@@ -50,7 +50,7 @@ and query information using the telemetry client python script.
 
 #. Launch the telemetry client script::
 
-      python usertools/dpdk-telemetry.py
+      ./usertools/dpdk-telemetry.py
 
 #. When connected, the script displays the following, waiting for user input::
 
index 33ce0c2..4477c1c 100644 (file)
@@ -154,7 +154,7 @@ Host2VM communication example
         modprobe uio
         echo 512 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages
         modprobe uio_pci_generic
-        python usertools/dpdk-devbind.py -b uio_pci_generic 00:03.0
+        ./usertools/dpdk-devbind.py -b uio_pci_generic 00:03.0
 
     We use testpmd as the forwarding application in this example.
 
@@ -329,7 +329,7 @@ To support Rx interrupts,
 
     .. code-block:: console
 
-        python usertools/dpdk-devbind.py -b vfio-pci 00:03.0
+        ./usertools/dpdk-devbind.py -b vfio-pci 00:03.0
 
 Example
 ~~~~~~~
index 0be208e..8080a28 100644 (file)
@@ -14,8 +14,8 @@ Deprecation Notices
 * meson: The minimum supported version of meson for configuring and building
   DPDK will be increased to v0.47.1 (from 0.41) from DPDK 19.05 onwards. For
   those users with a version earlier than 0.47.1, an updated copy of meson
-  can be got using the ``pip``, or ``pip3``, tool for downloading python
-  packages.
+  can be got using the ``pip3`` tool (or ``python3 -m pip``) for downloading
+  python packages.
 
 * kvargs: The function ``rte_kvargs_process`` will get a new parameter
   for returning key match count. It will ease handling of no-match case.
index 393c3e9..9969231 100644 (file)
@@ -43,7 +43,7 @@ The tool application has a number of command line options:
 
 .. code-block:: console
 
-  python test-bbdev.py [-h] [-p TESTAPP_PATH] [-e EAL_PARAMS] [-t TIMEOUT]
+    test-bbdev.py [-h] [-p TESTAPP_PATH] [-e EAL_PARAMS] [-t TIMEOUT]
                        [-c TEST_CASE [TEST_CASE ...]]
                        [-v TEST_VECTOR [TEST_VECTOR...]] [-n NUM_OPS]
                        [-b BURST_SIZE [BURST_SIZE ...]] [-l NUM_LCORES]