@@ -1,3 +1,8 @@
+# SPDX-FileCopyrightText: <text>Copyright 2020-2024 Arm Limited and/or its
+# affiliates <open-source-office@arm.com></text>
+#
+# SPDX-License-Identifier: MIT
+
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
@@ -50,6 +55,9 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'docs/infra']
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
+html_theme_options = {
+ 'flyout_display': 'attached',
+}
# Define the canonical URL if you are using a custom domain on Read the Docs
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
@@ -1,4 +1,4 @@
-# Copyright (c) 2022, Arm Limited.
+# Copyright (c) 2022-2024, Arm Limited.
#
# SPDX-License-Identifier: MIT
@@ -6,6 +6,6 @@
jinja2==3.1.1
# Required to build the documentation
-sphinx~=5.0
-sphinx_rtd_theme~=2.0.0
-docutils==0.17.1
+sphinx==7.1.2
+sphinx_rtd_theme~=3.0.0
+docutils~=0.18.1
Use flyout menu enabled via the `flyout_display` parameter to show the flyout in the bottom of the sidebar. The default Read the Docs (RtD) flyout needs to be disabled in order to not have 2 flyouts showing. It is done by disabling it in the RtD project settings. Additionally, the Sphinx theme needs to be upgraded from version 2.0.0 to version 3.0.0. The sphinx and docutils modules also need to be update for compatibility reason. Signed-off-by: Hugues KAMBA MPIANA <hugues.kambampiana@arm.com> --- meta-arm-bsp/documentation/corstone1000/conf.py | 8 ++++++++ meta-arm-bsp/documentation/requirements.txt | 8 ++++---- 2 files changed, 12 insertions(+), 4 deletions(-)