diff options
| author | Ben Pfaff <blp@ovn.org> | 2019-09-16 12:05:36 -0700 |
|---|---|---|
| committer | Ben Pfaff <blp@ovn.org> | 2019-09-20 08:34:34 -0700 |
| commit | ab4514890587d1d74e1d1c4d8e1c18926ca0642b (patch) | |
| tree | 4ee2983446c31f36bfc70cef437532645afb6123 /Documentation | |
| parent | 2a97891eb23b04ceb513ca7a860aafe91fe1555f (diff) | |
| download | openvswitch-ab4514890587d1d74e1d1c4d8e1c18926ca0642b.tar.gz | |
Recommend Sphinx from Python 3 in documentation and packaging.
Acked-by: Numan Siddique <nusididq@redhat.com>
Signed-off-by: Ben Pfaff <blp@ovn.org>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/intro/install/documentation.rst | 6 | ||||
| -rw-r--r-- | Documentation/intro/install/rhel.rst | 2 |
2 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/intro/install/documentation.rst b/Documentation/intro/install/documentation.rst index d7eb25d9e..acf5b3a3f 100644 --- a/Documentation/intro/install/documentation.rst +++ b/Documentation/intro/install/documentation.rst @@ -45,11 +45,11 @@ Sphinx. A detailed guide on installing Sphinx in many environments is available on the `Sphinx website`__ but, for most Linux distributions, you can install with your package manager. For example, on Debian/Ubuntu run:: - $ sudo apt-get install python-sphinx + $ sudo apt-get install python3-sphinx Similarly, on RHEL/Fedora run:: - $ sudo dnf install python-sphinx + $ sudo dnf install python3-sphinx A ``requirements.txt`` is also provided in the ``/Documentation``, should you wish to install using ``pip``:: @@ -71,7 +71,7 @@ available on the `Sphinx website`__. Building -------- -Once Sphinx installed, the documentation can be built using the provided +Once Sphinx is installed, the documentation can be built using the provided Makefile targets:: $ make docs-check diff --git a/Documentation/intro/install/rhel.rst b/Documentation/intro/install/rhel.rst index 6f062e894..0e5ca2743 100644 --- a/Documentation/intro/install/rhel.rst +++ b/Documentation/intro/install/rhel.rst @@ -89,7 +89,7 @@ And to install specific dependencies, use yum-builddep tool:: Once that is completed, remove the file ``/tmp/ovs.spec``. -If python-sphinx package is not available in your version of RHEL, you can +If python3-sphinx package is not available in your version of RHEL, you can install it via pip with 'pip install sphinx'. Open vSwitch requires python 2.7 or newer which is not available in older |