From c0507e6ad5b541e0313f41089b67073063221efc Mon Sep 17 00:00:00 2001 From: MartinMohrmann Date: Wed, 24 Apr 2024 11:18:40 +0200 Subject: [PATCH 1/9] revert some changes from #197 --- .readthedocs.yml | 3 ++- docs/conf.py | 2 +- docs/requirements.txt | 4 +--- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index cd1e6e5..7d0d629 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -9,7 +9,7 @@ version: 2 build: os: ubuntu-22.04 tools: - python: "3.12" + python: "3.11" # Build documentation in the docs/ directory with Sphinx sphinx: @@ -24,6 +24,7 @@ formats: all # Optionally set the version of Python and requirements required to build your docs python: + version: 3.11 install: - requirements: docs/requirements.txt diff --git a/docs/conf.py b/docs/conf.py index b353d81..290a54d 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -26,7 +26,7 @@ # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "1.4" +# needs_sphinx = "1.4" # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom diff --git a/docs/requirements.txt b/docs/requirements.txt index 3dec397..72609d4 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,2 @@ glidertools -docutils -recommonmark -sphinx-rtd-theme +docutils<0.18 From 5f817c087bac5de32fefb8553050cf3073a3beb2 Mon Sep 17 00:00:00 2001 From: MartinMohrmann Date: Wed, 24 Apr 2024 11:22:03 +0200 Subject: [PATCH 2/9] versions name --- .readthedocs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 7d0d629..2a7db0c 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -24,7 +24,6 @@ formats: all # Optionally set the version of Python and requirements required to build your docs python: - version: 3.11 install: - requirements: docs/requirements.txt From 504be6a19c16b43cb0a70ee4f5bac6fc64e03421 Mon Sep 17 00:00:00 2001 From: MartinMohrmann Date: Wed, 24 Apr 2024 11:26:22 +0200 Subject: [PATCH 3/9] docutils update --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 72609d4..054a1b8 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,2 @@ glidertools -docutils<0.18 +docutils From e5d40e182ab92f205d57c2df6791714adf52b797 Mon Sep 17 00:00:00 2001 From: MartinMohrmann Date: Wed, 24 Apr 2024 11:28:19 +0200 Subject: [PATCH 4/9] add recommonmark --- docs/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 054a1b8..9368577 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,3 @@ glidertools docutils +recommonmark From 4353918457188cfd13390dec190a59f8cf4f3a72 Mon Sep 17 00:00:00 2001 From: MartinMohrmann Date: Wed, 24 Apr 2024 15:05:28 +0200 Subject: [PATCH 5/9] give up abandoned theme --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 290a54d..289b748 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -122,7 +122,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = "sphinx_rtd_theme" +html_theme = "classic" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the From c96daf4329f37f8fbcd7ebc4656c9ebf58137264 Mon Sep 17 00:00:00 2001 From: MartinMohrmann Date: Wed, 24 Apr 2024 15:40:51 +0200 Subject: [PATCH 6/9] remove outdated html styling options --- docs/conf.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 289b748..62852e6 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -127,11 +127,11 @@ # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -html_theme_options = { - "logo_only": True, - "display_version": False, - "style_nav_header_background": "#343131", -} +# html_theme_options = { +# "logo_only": True, +# "display_version": False, +# "style_nav_header_background": "#343131", +# } # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] From 25b979b2d2e8d462b0306198eee5c9e808382935 Mon Sep 17 00:00:00 2001 From: MartinMohrmann Date: Wed, 24 Apr 2024 15:45:59 +0200 Subject: [PATCH 7/9] use classic css instead of custom --- docs/conf.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 62852e6..07f1311 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -155,12 +155,12 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["static"] +# html_static_path = ["static"] # custom CSS files -html_context = { - "css_files": ["_static/css/custom.css"], -} +# html_context = { +# "css_files": ["_static/css/custom.css"], +# } # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied From 5d30d35989c0c70e9242c1de0b45a7c704cccb6d Mon Sep 17 00:00:00 2001 From: MartinMohrmann Date: Thu, 16 May 2024 11:35:58 +0300 Subject: [PATCH 8/9] change theme to sphinx_rtd_theme --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 07f1311..2bfb6ab 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -122,7 +122,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = "classic" +html_theme = "sphinx_rtd_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the From 5106764879f9676ce940ee04eefab66013e58f68 Mon Sep 17 00:00:00 2001 From: MartinMohrmann Date: Thu, 16 May 2024 11:39:37 +0300 Subject: [PATCH 9/9] add requirement --- docs/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 9368577..3dec397 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,4 @@ glidertools docutils recommonmark +sphinx-rtd-theme