From 93478e5ecbe84d232d64bff3b0c5ff85561ec6a8 Mon Sep 17 00:00:00 2001 From: Pierre Villemot Date: Mon, 26 Aug 2024 11:35:18 +0200 Subject: [PATCH] Switch to Furo theme I dislike rtd theme we use for our sphinx documentation. This PR replaces it by Furo theme. This theme is more responsive. --- docs/sphinx_docs/conf.py | 4 ++-- docs/sphinx_docs/requirements.txt | 2 +- nix/default.nix | 1 + shell.nix | 2 +- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/sphinx_docs/conf.py b/docs/sphinx_docs/conf.py index d7a305224..2c0d518a4 100644 --- a/docs/sphinx_docs/conf.py +++ b/docs/sphinx_docs/conf.py @@ -17,7 +17,7 @@ # -- Project information ----------------------------------------------------- -project = 'Alt-Ergo Documentation' +project = 'Alt-Ergo' copyright = '2020 - 2023, Alt-Ergo developers' author = 'Alt-Ergo developers' @@ -57,7 +57,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 = 'furo' html_theme_options = { 'navigation_depth': 5, } diff --git a/docs/sphinx_docs/requirements.txt b/docs/sphinx_docs/requirements.txt index 9d728ad7e..a733578c0 100644 --- a/docs/sphinx_docs/requirements.txt +++ b/docs/sphinx_docs/requirements.txt @@ -4,6 +4,6 @@ ###### Requirements for sphinx doc ###### sphinx >= 4.4.0 myst-parser -sphinx_rtd_theme +furo sphinx-markdown-tables # diff --git a/nix/default.nix b/nix/default.nix index 7742f9083..00ee3ecf9 100644 --- a/nix/default.nix +++ b/nix/default.nix @@ -12,6 +12,7 @@ import sources.nixpkgs { dolmen_loop = pkgs.callPackage ./dolmen_loop.nix { }; landmarks = pkgs.callPackage ./landmarks.nix { }; landmarks-ppx = pkgs.callPackage ./landmarks-ppx.nix { }; + furo = pkgs.callPackage ./furo.nix { }; }); }) ]; diff --git a/shell.nix b/shell.nix index e236f54d6..1c4f80e07 100644 --- a/shell.nix +++ b/shell.nix @@ -13,7 +13,7 @@ pkgs.mkShell { pkgs.sphinx python3Packages.myst-parser python3Packages.sphinx-markdown-tables - python3Packages.sphinx-rtd-theme + python3Packages.furo ocaml dune_3 ocaml-lsp