mirror of
https://github.com/openvswitch/ovs
synced 2025-08-22 01:51:26 +00:00
Recommend Sphinx from Python 3 in documentation and packaging.
Acked-by: Numan Siddique <nusididq@redhat.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
This commit is contained in:
parent
2a97891eb2
commit
ab45148905
@ -20,7 +20,7 @@ addons:
|
||||
- libjemalloc1
|
||||
- libjemalloc-dev
|
||||
- libnuma-dev
|
||||
- python-sphinx
|
||||
- python3-sphinx
|
||||
- libelf-dev
|
||||
- selinux-policy-dev
|
||||
- libunbound-dev
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -1,4 +1,4 @@
|
||||
#! /usr/bin/env python
|
||||
#! /usr/bin/env python3
|
||||
# Copyright (c) 2017 Red Hat, Inc.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
|
@ -79,7 +79,7 @@ BuildRequires: python3-devel
|
||||
BuildRequires: desktop-file-utils
|
||||
BuildRequires: groff graphviz
|
||||
BuildRequires: checkpolicy, selinux-policy-devel
|
||||
BuildRequires: /usr/bin/sphinx-build
|
||||
BuildRequires: /usr/bin/sphinx-build-3
|
||||
# make check dependencies
|
||||
BuildRequires: %{_py2}-twisted%{?rhel:-core} %{_py2}-zope-interface %{_py2}-six
|
||||
BuildRequires: procps-ng
|
||||
|
@ -37,7 +37,7 @@ BuildRequires: python-six
|
||||
BuildRequires: openssl-devel
|
||||
BuildRequires: checkpolicy, selinux-policy-devel
|
||||
BuildRequires: autoconf, automake, libtool
|
||||
BuildRequires: python-sphinx
|
||||
BuildRequires: python3-sphinx
|
||||
BuildRequires: unbound-devel
|
||||
|
||||
%bcond_without check
|
||||
|
Loading…
x
Reference in New Issue
Block a user