From 9aef9c6917f3aa49e07b7332ad9c59dc82d60e92 Mon Sep 17 00:00:00 2001 From: Sergiy Markin Date: Sat, 5 Oct 2024 17:39:25 +0000 Subject: [PATCH] Fix for readthedocs publishing Also updated docs generation code caused by deprecated properties in recent version of Sphinx. Change-Id: If3892cde658bb9d92b4b465f8ec4b1b210fc0ec0 --- .readthedocs.yaml | 28 ++++++++++++++++++++++++++++ doc/requirements.txt | 4 ++-- doc/source/conf.py | 5 ++--- 3 files changed, 32 insertions(+), 5 deletions(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..ce94279d1 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,28 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation in the doc/ directory with Sphinx +sphinx: + configuration: doc/source/conf.py + +# Build documentation with MkDocs +#mkdocs: +# configuration: mkdocs.yml + +# Optionally build your docs in additional formats such as PDF and ePub +formats: + - pdf + +build: + os: "ubuntu-22.04" + tools: + python: "3.10" + +# Optionally set the version of Python and requirements required to build your docs +python: + install: + - requirements: doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt index ce8e6b307..82133027c 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,2 +1,2 @@ -sphinx>=1.6.2 -sphinx_rtd_theme>=0.4.3 +sphinx +sphinx_rtd_theme diff --git a/doc/source/conf.py b/doc/source/conf.py index 1862c2b38..de96e0bab 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -19,7 +19,7 @@ # import os # import sys # sys.path.insert(0, os.path.abspath('.')) -import sphinx_rtd_theme +# import sphinx_rtd_theme # -- General configuration ------------------------------------------------ @@ -89,9 +89,8 @@ todo_include_todos = False # html_logo = '_static/airship.logo.white.svg' html_theme = "sphinx_rtd_theme" -html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + html_theme_options = { - 'display_version': False, 'logo_only': True } html_show_sourcelink = False