docs: add dark mode

docs/conf.py

@@ -32,6 +32,7 @@
  "sphinx_tabs.tabs",
  "sphinx_copybutton",
  "sphinxext.opengraph",
+ "sphinx_rtd_dark_mode",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -301,6 +302,9 @@ def setup(app):
 # sphinx-tabs configuration
 sphinx_tabs_disable_tab_closing = True
 
+# sphinx_rtd_dark_mode configuration
+default_dark_mode = False
+
 # sphinxext-opengraph configuration
 
 ogp_image = "_images/logo.png"

nix/docs-extensions/sphinx-rtd-dark-mode.nix

@@ -0,0 +1,29 @@
+{ lib
+, buildPythonPackage
+, fetchPypi
+, sphinx
+}:
+
+buildPythonPackage rec {
+ pname = "sphinx_rtd_dark_mode";
+ version = "1.3.0";
+
+ src = fetchPypi {
+ inherit pname version;
+ sha256 = "sha256-AnK/PZ72IJIa3GflY0pmlpQZ50TahOoYgwraz9sWDqg=";
+ };
+
+ propagatedBuildInputs = [
+ sphinx
+ ];
+
+ doCheck = false;
+
+ pythonImportsCheck = [ "sphinx_rtd_dark_mode" ];
+
+ meta = with lib; {
+ description = "Dark mode for the Sphinx Read the Docs theme";
+ homepage = "https://github.com/MrDogeBro/sphinx_rtd_dark_mode";
+ license = licenses.mit;
+ };
+}

nix/tools/docs.nix

@@ -16,6 +16,7 @@ let
  ps.sphinx-tabs
  ps.sphinx-copybutton
  ps.sphinxext-opengraph
+ (ps.callPackage ../docs-extensions/sphinx-rtd-dark-mode.nix {})
  # TODO: Remove override once new sphinx-intl version (> 2.1.0) is released and available in nixpkgs
  (ps.sphinx-intl.overrideAttrs (drv: { nativeBuildInputs = drv.nativeBuildInputs ++ [ ps.six ]; }))
  ];