From 419f3148c18fa744c04c4df1c531512c5e8d1f3f Mon Sep 17 00:00:00 2001 From: Abolfazl Shahbazi Date: Fri, 6 Oct 2023 15:15:21 -0700 Subject: [PATCH] Fix GitHub docs build (#245) Signed-off-by: Abolfazl Shahbazi --- README.md | 2 +- docs/conf.py | 2 ++ docs/requirements-docs.txt | 7 ++++--- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0bdc515..706d885 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ There are two Python* components in the repository: ### Requirements * Linux system or WSL2 on Windows (validated on Ubuntu* 20.04/22.04 LTS) -* Python 3.9 +* Python 3.8, 3.9, 3.10 * Install required OS packages with `apt-get install build-essential python3-dev` * git (only required for the "Developer Installation") diff --git a/docs/conf.py b/docs/conf.py index 3122d23..3ccf00f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -37,12 +37,14 @@ 'nbsphinx', 'nbsphinx_link', 'sphinx_design', + 'sphinx_external_toc', 'sphinx.ext.intersphinx', 'sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.viewcode', 'sphinx.ext.doctest', ] +external_toc_path = "toc.yml" external_toc_exclude_missing = False html_theme = 'sphinx_rtd_theme' nbsphinx_execute = 'never' diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 67f2669..69a788b 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,12 +1,13 @@ -Sphinx==7.1.2; python_version=='3.8' -Sphinx==7.2.6; python_version>'3.8' +Sphinx==5.3.0 docutils==0.18.1 +docutils~=0.18.1 ghp-import==2.1.0 linkify-it-py==2.0.2 -myst-parser==2.0.0 +myst-parser==1.0.0 nbsphinx-link==1.3.0 nbsphinx==0.9.3 sphinx-fontawesome==0.0.6 sphinx-multitoc-numbering==0.1.3 sphinx-rtd-theme==1.3.0 sphinx_design==0.5.0 +sphinx_external_toc==0.3.1