From patchwork Thu Nov 2 16:15:24 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ilya Maximets X-Patchwork-Id: 1858602 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=openvswitch.org (client-ip=2605:bc80:3010::136; helo=smtp3.osuosl.org; envelope-from=ovs-dev-bounces@openvswitch.org; receiver=patchwork.ozlabs.org) Received: from smtp3.osuosl.org (smtp3.osuosl.org [IPv6:2605:bc80:3010::136]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (secp384r1) server-digest SHA384) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4SLpqG0wFcz1yQs for ; Fri, 3 Nov 2023 03:14:33 +1100 (AEDT) Received: from localhost (localhost [127.0.0.1]) by smtp3.osuosl.org (Postfix) with ESMTP id DCE027066A; Thu, 2 Nov 2023 16:14:31 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp3.osuosl.org DCE027066A X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp3.osuosl.org ([127.0.0.1]) by localhost (smtp3.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id BU4pfAl5RIpu; Thu, 2 Nov 2023 16:14:30 +0000 (UTC) Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [IPv6:2605:bc80:3010:104::8cd3:938]) by smtp3.osuosl.org (Postfix) with ESMTPS id 9C3EE70711; Thu, 2 Nov 2023 16:14:29 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp3.osuosl.org 9C3EE70711 Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id 7F1B0C008C; Thu, 2 Nov 2023 16:14:29 +0000 (UTC) X-Original-To: ovs-dev@openvswitch.org Delivered-To: ovs-dev@lists.linuxfoundation.org Received: from smtp2.osuosl.org (smtp2.osuosl.org [140.211.166.133]) by lists.linuxfoundation.org (Postfix) with ESMTP id 7FE60C0032 for ; Thu, 2 Nov 2023 16:14:26 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp2.osuosl.org (Postfix) with ESMTP id 63513434E7 for ; Thu, 2 Nov 2023 16:14:25 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp2.osuosl.org 63513434E7 X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp2.osuosl.org ([127.0.0.1]) by localhost (smtp2.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id CirPDJClHg6M for ; Thu, 2 Nov 2023 16:14:20 +0000 (UTC) Received: from relay3-d.mail.gandi.net (relay3-d.mail.gandi.net [217.70.183.195]) by smtp2.osuosl.org (Postfix) with ESMTPS id 1CF94434EC for ; Thu, 2 Nov 2023 16:14:19 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp2.osuosl.org 1CF94434EC Received: by mail.gandi.net (Postfix) with ESMTPSA id 394336000D; Thu, 2 Nov 2023 16:14:18 +0000 (UTC) From: Ilya Maximets To: ovs-dev@openvswitch.org Date: Thu, 2 Nov 2023 17:15:24 +0100 Message-ID: <20231102161527.385815-2-i.maximets@ovn.org> X-Mailer: git-send-email 2.41.0 In-Reply-To: <20231102161527.385815-1-i.maximets@ovn.org> References: <20231102161527.385815-1-i.maximets@ovn.org> MIME-Version: 1.0 X-GND-Sasl: i.maximets@ovn.org Cc: Ilya Maximets Subject: [ovs-dev] [PATCH ovn 1/2] Documentation: Use theme from Read The Docs. X-BeenThere: ovs-dev@openvswitch.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: ovs-dev-bounces@openvswitch.org Sender: "dev" 'ovs-sphinx-theme' is designed to look like an openvswitch.org website. It contains OVS logo and navigation bars from the openvswitch.org. And that doesn't really make a lot of sense for OVN. Also, currently the ovs-sphinx-theme is not actually installed by the Read The Docs configuration, so the docs.ovn.org is using default alabaster theme instead. Switch to sphinx_rtd_theme, it looks close to the main ovn.org website. Remove the upper limit on sphinx version, because the theme may require higher versions and also sphinx 2.0 is very old and fails to be installed on Read The Docs servers. The import in conf.py will not be actually used, importing only to check availability, so ignoring the F401 'imported but unused'. Signed-off-by: Ilya Maximets Acked-by: Mark Michelson --- Documentation/conf.py | 20 +++++++------------- Documentation/internals/documentation.rst | 18 +++++++----------- Documentation/requirements.txt | 4 ++-- 3 files changed, 16 insertions(+), 26 deletions(-) diff --git a/Documentation/conf.py b/Documentation/conf.py index f7eceaec8..5cd0041b8 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -16,12 +16,12 @@ import string import sys try: - import ovs_sphinx_theme - use_ovs_theme = True + import sphinx_rtd_theme # noqa: F401 + use_rtd_theme = True except ImportError: - print("Cannot find 'ovs-sphinx-theme' package. " + print("Cannot find 'sphinx_rtd_theme' package. " "Falling back to default theme.") - use_ovs_theme = False + use_rtd_theme = False # -- General configuration ------------------------------------------------ @@ -48,7 +48,7 @@ master_doc = 'contents' # General information about the project. project = u'Open Virtual Network (OVN)' -copyright = u'2020, The Open Virtual Network (OVN) Development Community' +copyright = u'2020-2023, The Open Virtual Network (OVN) Development Community' author = u'The Open Virtual Network (OVN) Development Community' # The version info for the project you're documenting, acts as replacement for @@ -89,14 +89,8 @@ linkcheck_anchors = False # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -if use_ovs_theme: - html_theme = 'ovs' - -# Add any paths that contain custom themes here, relative to this directory. -if use_ovs_theme: - html_theme_path = [ovs_sphinx_theme.get_theme_dir()] -else: - html_theme_path = [] +if use_rtd_theme: + html_theme = 'sphinx_rtd_theme' # The name of an image file (relative to this directory) to place at the top # of the sidebar. diff --git a/Documentation/internals/documentation.rst b/Documentation/internals/documentation.rst index 72a120bef..59c18b3a2 100644 --- a/Documentation/internals/documentation.rst +++ b/Documentation/internals/documentation.rst @@ -41,17 +41,13 @@ variety of other output formats but also allows for things like cross-referencing and indexing. for more information on the two, refer to the :doc:`contributing/documentation-style`. -ovs-sphinx-theme +sphinx_rtd_theme ---------------- -The documentation uses its own theme, `ovs-sphinx-theme`, which can be found on -GitHub__ and is published on pypi__. This is shared by Open vSwitch and OVN. -It is packaged separately to ensure all documentation gets the latest version -of the theme (assuming there are no major version bumps in that package). If -building locally and the package is installed, it will be used. If the package -is not installed, Sphinx will fallback to the default theme. - -The package is currently maintained by Stephen Finucane and Russell Bryant. +The documentation uses `sphinx_rtd_theme`, which can be found on GitHub__ and +is published on pypi__. It is also packaged in major distributions. +If building locally and the package is installed, it will be used. If the +package is not installed, Sphinx will fallback to the default theme. Read the Docs ------------- @@ -72,6 +68,6 @@ modifications to this site, refer to the `GitHub project`__. __ http://docutils.sourceforge.net/rst.html __ http://www.sphinx-doc.org/ -__ https://github.com/openvswitch/ovs-sphinx-theme -__ https://pypi.python.org/pypi/ovs-sphinx-theme +__ https://github.com/readthedocs/sphinx_rtd_theme +__ https://pypi.python.org/pypi/sphinx_rtd_theme __ https://github.com/ovn-org/ovn-org.github.io diff --git a/Documentation/requirements.txt b/Documentation/requirements.txt index 77130c6e0..63a7997f7 100644 --- a/Documentation/requirements.txt +++ b/Documentation/requirements.txt @@ -1,2 +1,2 @@ -sphinx>=1.1,<2.0 -ovs_sphinx_theme>=1.0,<1.1 +sphinx>=1.1 +sphinx_rtd_theme>=1.0,<2.0 From patchwork Thu Nov 2 16:15:25 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ilya Maximets X-Patchwork-Id: 1858603 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=openvswitch.org (client-ip=2605:bc80:3010::133; helo=smtp2.osuosl.org; envelope-from=ovs-dev-bounces@openvswitch.org; receiver=patchwork.ozlabs.org) Received: from smtp2.osuosl.org (smtp2.osuosl.org [IPv6:2605:bc80:3010::133]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (secp384r1) server-digest SHA384) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4SLpqK5Fgjz1yQs for ; Fri, 3 Nov 2023 03:14:37 +1100 (AEDT) Received: from localhost (localhost [127.0.0.1]) by smtp2.osuosl.org (Postfix) with ESMTP id 855EB43510; Thu, 2 Nov 2023 16:14:34 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp2.osuosl.org 855EB43510 X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp2.osuosl.org ([127.0.0.1]) by localhost (smtp2.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 2FmVPtI0QnNf; Thu, 2 Nov 2023 16:14:33 +0000 (UTC) Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [140.211.9.56]) by smtp2.osuosl.org (Postfix) with ESMTPS id 5130F4350E; Thu, 2 Nov 2023 16:14:31 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp2.osuosl.org 5130F4350E Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id 3971DC0DD3; Thu, 2 Nov 2023 16:14:30 +0000 (UTC) X-Original-To: ovs-dev@openvswitch.org Delivered-To: ovs-dev@lists.linuxfoundation.org Received: from smtp4.osuosl.org (smtp4.osuosl.org [IPv6:2605:bc80:3010::137]) by lists.linuxfoundation.org (Postfix) with ESMTP id 56424C0DD2 for ; Thu, 2 Nov 2023 16:14:27 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp4.osuosl.org (Postfix) with ESMTP id 243624EE0E for ; Thu, 2 Nov 2023 16:14:27 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp4.osuosl.org 243624EE0E X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp4.osuosl.org ([127.0.0.1]) by localhost (smtp4.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id nV2Jj3YbWIBW for ; Thu, 2 Nov 2023 16:14:22 +0000 (UTC) Received: from relay3-d.mail.gandi.net (relay3-d.mail.gandi.net [IPv6:2001:4b98:dc4:8::223]) by smtp4.osuosl.org (Postfix) with ESMTPS id D93BF4EDBE for ; Thu, 2 Nov 2023 16:14:21 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp4.osuosl.org D93BF4EDBE Received: by mail.gandi.net (Postfix) with ESMTPSA id 1F47F6000B; Thu, 2 Nov 2023 16:14:19 +0000 (UTC) From: Ilya Maximets To: ovs-dev@openvswitch.org Date: Thu, 2 Nov 2023 17:15:25 +0100 Message-ID: <20231102161527.385815-3-i.maximets@ovn.org> X-Mailer: git-send-email 2.41.0 In-Reply-To: <20231102161527.385815-1-i.maximets@ovn.org> References: <20231102161527.385815-1-i.maximets@ovn.org> MIME-Version: 1.0 X-GND-Sasl: i.maximets@ovn.org Cc: Ilya Maximets Subject: [ovs-dev] [PATCH ovn 2/2] readthedocs: Add the configuration file. X-BeenThere: ovs-dev@openvswitch.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: ovs-dev-bounces@openvswitch.org Sender: "dev" Since last month ReadTheDocs only supports building with a new configuration file provided in the repository itself: https://blog.readthedocs.com/migrate-configuration-v2/ So, all our documentation builds are failing for quite some time. Add the configuration file to unblock documentation updates. Signed-off-by: Ilya Maximets Acked-by: Mark Michelson --- .readthedocs.yaml | 26 ++++++++++++++++++++++++++ Makefile.am | 1 + 2 files changed, 27 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..8c451663a --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,26 @@ +# .readthedocs.yaml +# Read the Docs configuration file. +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details. + +# Required. +version: 2 + +# Set the OS, Python version, etc. +build: + os: ubuntu-22.04 + tools: + python: "3.12" + +# Build documentation in the "Documentation/" directory with Sphinx. +sphinx: + configuration: Documentation/conf.py + # Default HTML builder. + builder: "html" + +# Build all formats: HTML, PDF, ePub. +formats: all + +# Declare the Python requirements. +python: + install: + - requirements: Documentation/requirements.txt diff --git a/Makefile.am b/Makefile.am index 06045760a..98bbb9a1f 100644 --- a/Makefile.am +++ b/Makefile.am @@ -100,6 +100,7 @@ EXTRA_DIST = \ .github/workflows/test.yml \ .github/workflows/ovn-kubernetes.yml \ .github/workflows/ovn-fake-multinode-tests.yml \ + .readthedocs.yaml \ boot.sh \ $(MAN_FRAGMENTS) \ $(MAN_ROOTS) \