mir/ovs
2
0
Fork 0
mirror of https://github.com/openvswitch/ovs synced 2025-08-22 09:58:01 +00:00
Code Issues Releases Wiki Activity

Recommend Sphinx from Python 3 in documentation and packaging.

Browse Source 
Acked-by: Numan Siddique <nusididq@redhat.com>
Signed-off-by: Ben Pfaff <blp@ovn.org>
This commit is contained in:
Ben Pfaff 2019-09-16 12:05:36 -07:00
parent 2a97891eb2
commit ab45148905
6 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.travis.yml
View File

@ -20,7 +20,7 @@ addons:
- libjemalloc1 - libjemalloc1
- libjemalloc-dev - libjemalloc-dev
- libnuma-dev - libnuma-dev
- python-sphinx - python3-sphinx
- libelf-dev - libelf-dev
- selinux-policy-dev - selinux-policy-dev
- libunbound-dev - libunbound-dev

6
Documentation/intro/install/documentation.rst
View File

@ -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 on the `Sphinx website`__ but, for most Linux distributions, you can install
with your package manager. For example, on Debian/Ubuntu run:: 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:: 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 A ``requirements.txt`` is also provided in the ``/Documentation``, should you
wish to install using ``pip``:: wish to install using ``pip``::
@ -71,7 +71,7 @@ available on the `Sphinx website`__.
Building 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:: Makefile targets::
$ make docs-check $ make docs-check

2
Documentation/intro/install/rhel.rst
View File

@ -89,7 +89,7 @@ And to install specific dependencies, use yum-builddep tool::
Once that is completed, remove the file ``/tmp/ovs.spec``. 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'. install it via pip with 'pip install sphinx'.
Open vSwitch requires python 2.7 or newer which is not available in older Open vSwitch requires python 2.7 or newer which is not available in older

2
build-aux/dpdkstrip.py
View File

@ -1,4 +1,4 @@
#! /usr/bin/env python #! /usr/bin/env python3
# Copyright (c) 2017 Red Hat, Inc. # Copyright (c) 2017 Red Hat, Inc.
# #
# Licensed under the Apache License, Version 2.0 (the "License"); # Licensed under the Apache License, Version 2.0 (the "License");

2
rhel/openvswitch-fedora.spec.in
View File

@ -79,7 +79,7 @@ BuildRequires: python3-devel
BuildRequires: desktop-file-utils BuildRequires: desktop-file-utils
BuildRequires: groff graphviz BuildRequires: groff graphviz
BuildRequires: checkpolicy, selinux-policy-devel BuildRequires: checkpolicy, selinux-policy-devel
BuildRequires: /usr/bin/sphinx-build BuildRequires: /usr/bin/sphinx-build-3
# make check dependencies # make check dependencies
BuildRequires: %{_py2}-twisted%{?rhel:-core} %{_py2}-zope-interface %{_py2}-six BuildRequires: %{_py2}-twisted%{?rhel:-core} %{_py2}-zope-interface %{_py2}-six
BuildRequires: procps-ng BuildRequires: procps-ng

2
rhel/openvswitch.spec.in
View File

@ -37,7 +37,7 @@ BuildRequires: python-six
BuildRequires: openssl-devel BuildRequires: openssl-devel
BuildRequires: checkpolicy, selinux-policy-devel BuildRequires: checkpolicy, selinux-policy-devel
BuildRequires: autoconf, automake, libtool BuildRequires: autoconf, automake, libtool
BuildRequires: python-sphinx BuildRequires: python3-sphinx
BuildRequires: unbound-devel BuildRequires: unbound-devel
%bcond_without check %bcond_without check