project: bump flake,python, theme: press -> awesome

doyougnu · doyougnu · commit b0f90033f7e9 · 2026-01-16T11:07:25.000-05:00
diff --git a/conf.py b/conf.py
@@ -113,8 +113,8 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme      = "press"
-html_theme_options = { "body_max_width": 1600 }
+html_theme      = "sphinxawesome_theme"
+html_theme_options = { "body_max_width": 1600 } # "config_file": "theme.toml",}
 html_static_path = ['_static', 'code']
 html_css_files = [ 'css/s4defs-roles.css', 'css/iframe.css', 'css/admonitions.css' ]
 
diff --git a/custom.rst b/custom.rst
@@ -8,6 +8,6 @@
 .. |bottom| replace:: :math:`\bot`
 ..
    GHC Specific
-.. |ghcVersion| replace:: 9.2.x
+.. |ghcVersion| replace:: 9.x
 .. |core| replace:: Core
 .. |stg| replace:: Stg
diff --git a/flake.lock b/flake.lock
diff --git a/flake.nix b/flake.nix
@@ -10,54 +10,81 @@
   };
 
   outputs = { self, nixpkgs, flake-utils, flake-compat }:
-    let press-theme-overlay = final: prev: {
-          sphinx-press-theme = prev.python311Packages.buildPythonPackage rec {
-            pname = "sphinx_press_theme";
-            version = "0.8.0";
+    let pythonEnv-overlay = final: prev: {
+      python313Packages = prev.python313Packages.overrideScope (pyFinal: pyPrev: {
 
-            src = prev.python311Packages.fetchPypi {
-              inherit pname;
-              inherit version;
-              sha256 = "sha256-KITKqx3AHssR0VjU3W0xeeLdl81IUWx2nMJzYCcuYrM=";
-            };
-            propagatedBuildInputs = [ prev.sphinx ];
-          };
-        };
+          # sphinx-press-theme = pyPrev.buildPythonPackage rec {
+            # pname = "sphinx-press-theme";
+            # pyproject = true;
+            # build-system = [ pyPrev.setuptools ];
+            # version = "0.9.1";
 
-        copy-button-overlay = final: prev: {
-          sphinx-copybutton = prev.python311Packages.buildPythonPackage rec {
+            # src = pyPrev.fetchPypi {
+              # inherit pname;
+              # inherit version;
+              # sha256 = "sha256-KITKqx3AHssR0VjU3W0xeeLdl81IUWx2nMJzYCcuYrM=";
+            # };
+            # propagatedBuildInputs = [ pyPrev.sphinx ];
+          # };
+
+
+          sphinx-copybutton = pyPrev.buildPythonPackage rec {
             pname = "sphinx-copybutton";
+            pyproject = true;
+            build-system = [ pyPrev.setuptools ];
             version = "0.5.2";
 
-            src = prev.python311Packages.fetchPypi {
+            src = pyPrev.fetchPypi {
               inherit pname;
               inherit version;
               sha256 = "sha256-TPF8gvuWRtG8nKkqwoCBOjtgXYxCEiX9mRMVQQPuH70=";
             };
-            propagatedBuildInputs = [ prev.sphinx ];
+            propagatedBuildInputs = [ pyPrev.sphinx ];
           };
-        };
 
-        sphinx-exec-directive-overlay = final: prev: {
-          sphinx-exec-directive = prev.python311Packages.buildPythonPackage rec {
+          sphinx-exec-directive = pyPrev.buildPythonPackage rec {
             pname   = "sphinx-exec-directive";
+            pyproject = true;
+            build-system = [ pyPrev.setuptools ];
+
             version = "0.6";
 
-            src = prev.python311Packages.fetchPypi {
+            src = pyPrev.fetchPypi {
               inherit pname;
               inherit version;
               sha256 = "sha256-lMo4QILqt6pEiIatN/LNxhiUGX3ziSWV+bfRahzmZWU=";
             };
-            propagatedBuildInputs = [ prev.sphinx prev.python311Packages.matplotlib ];
+            propagatedBuildInputs = [ pyPrev.sphinx
+                                      pyPrev.matplotlib
+                                    ];
           };
-        };
 
-        tex-overlay = final: prev: {
-            tex-env = prev.texlive.combine {
-              inherit (prev.texlive)
-                scheme-basic collection-xetex fncychap titlesec tabulary varwidth
-                framed capt-of wrapfig needspace dejavu-otf helvetic upquote
-                memorygraphs;
+          sphinxcontrib-bibtex = pyPrev.buildPythonPackage rec {
+            pname   = "sphinxcontrib_bibtex"; # yes they are inconsistent with the name
+            pyproject = true;
+            build-system = [ pyPrev.setuptools ];
+
+            version = "2.6.5";
+
+            src = pyPrev.fetchPypi {
+              inherit pname;
+              inherit version;
+              sha256 = "sha256-mzIk3W/s6SaOvYyQXcCoP/L2xUFIqSNf5w6dHp/xScA=";
+            };
+            propagatedBuildInputs = [ pyPrev.sphinx
+                                      pyPrev.pybtex
+                                      pyPrev.pybtex-docutils
+                                    ];
+          };
+      });
+      };
+
+      tex-overlay = final: prev: {
+          tex-env = prev.texlive.combine {
+            inherit (prev.texlive)
+              scheme-basic collection-xetex fncychap titlesec tabulary varwidth
+              framed capt-of wrapfig needspace dejavu-otf helvetic upquote
+              memorygraphs;
             };
         };
 
@@ -66,9 +93,7 @@
       (system:
         let pkgs = import nixpkgs
               { inherit system;
-                overlays = [ press-theme-overlay
-                             copy-button-overlay
-                             sphinx-exec-directive-overlay
+                overlays = [ pythonEnv-overlay
                              tex-overlay
                            ];
               } ;
diff --git a/hoh.nix b/hoh.nix
@@ -3,22 +3,18 @@
 }:
 
 let
-   pythonInputs = with pkgs.python311Packages; [
-     sphinx
-     sphinxcontrib-bibtex
+   pythonEnv = pkgs.python313.withPackages (ps: with ps;
+   [ sphinx
      sphinxcontrib-tikz
      sphinx-autobuild
+     sphinxawesome-theme
+     sphinx-copybutton  # this comes from the overlay
+     sphinxcontrib-bibtex # from overlay
+     # sphinx-exec-directive
      pip
-     # marked as broken in nixpkgs unfortunately
-     # sphinx-book-theme
-     ## until we have a reason for tex leave this commented out for CI
-   ];
-   nonPythonInputs = with pkgs; [ sphinx-press-theme # this comes from the overlay
-                                  sphinx-copybutton  # this comes from the overlay
-                                  # pandoc
-                                  # change once extension fixes are upstreamed
-                                  sphinx-exec-directive
-                                  rst2html5
+   ]);
+
+   nonPythonInputs = with pkgs; [ rst2html5
                                   ghc
                                   cabal-install
                                   git
@@ -30,7 +26,7 @@ pkgs.stdenv.mkDerivation {
    version = "0.0.1";
    src     = ./.;
    phases = [ "unpackPhase" "preBuild" "buildPhase" "installPhase"];
-   buildInputs = pythonInputs ++ nonPythonInputs;
+   buildInputs = [pythonEnv] ++ nonPythonInputs;
 
    preBuild = ''
    unset SOURCE_DATE_EPOCH
@@ -40,7 +36,7 @@ pkgs.stdenv.mkDerivation {
 
    buildPhase = ''
    runHook preBuild
-   export PATH="${pkgs.lib.makeBinPath (pythonInputs ++ nonPythonInputs)}:$PATH";
+   export PATH="${pkgs.lib.makeBinPath (nonPythonInputs)}:$PATH";
    SOURCE_DATE_EPOCH="$(${pkgs.coreutils}/bin/date '+%s')"
    make clean
    make ${target} SPHINXOPTS="-W"
diff --git a/index.rst b/index.rst
@@ -5,11 +5,11 @@ Haskell Optimization Handbook
 *by Jeffrey M. Young*
 
 
-This book assumes you are using ghc |ghcVersion| or above and using the Linux
-operating system. If you are new then the best place to start is the :doc:`How
-to use this book </src/Preliminaries/how_to_use>` chapter. If you are returning
-then feel free to jump to the :ref:`mastertoc` and best wishes. It is dangerous
-to go alone, please take this handbook and good luck!
+This book assumes you are using ghc |ghcVersion| and using the Linux operating
+system. If you are new then the best place to start is the :doc:`How to use this
+book </src/Preliminaries/how_to_use>` chapter. If you are returning then feel
+free to jump to the :ref:`mastertoc` and best wishes. It is dangerous to go
+alone, please take this handbook and good luck!
 
 Sincerely,
 
diff --git a/src/Measurement_Observation/Core_Profiling/data_type_memory_footprint.rst b/src/Measurement_Observation/Core_Profiling/data_type_memory_footprint.rst
@@ -465,7 +465,7 @@ A total of 387 words which is 3, 096 bytes or roughly 3KiB, just for 32
 elements! Unfortunately, this also will not be a cache friendly data structure.
 To store 387 words we need :math:`\frac{387}{8} = 48` cache lines. But 387 is
 not a multiple of 2, so there will be :math:`387 \bmod{} 8 = 3` words of
-leftover space on the final cache line [#]_. A more cache friendly data
+leftover space on the final cache line [#f1]_. A more cache friendly data
 structure would ensure that a ``Full`` always fit evenly into a set of cache
 lines and would thereby avoid fragmenting the cache. One caveat is that this
 wasted space will change depending on the sizes of the key and value.
@@ -731,11 +731,11 @@ Which is just what we expected: one word (``.quad (,)_con_info``) for the data
 constructor header, one for ``fst`` (``.quad stg_INTLIKE_closure+273`` ), and
 one ``snd`` (``.quad stg_INTLIKE_closure+289``). However, GHC has added another
 word that is mysteriously set to 3: ``.quad 3``. This extra word is an
-optimization that GHC applies which tags the symbol ``Main.a_pair_closure`` as a
+optimization that GHC applies which tags [#f3]_ the symbol ``Main.a_pair_closure`` as a
 static constructor that contains no :term:`CAF` references. This tag (the 3)
 instructs the garbage collector to ignore this symbol during garbage collection.
 If ``Main.a_pair_closure`` was found to possibly have a CAF then the tag would
-have been 0 but the extra word would still exist [#]_ . So does this mean that
+have been 0 but the extra word would still exist [#f2]_. So does this mean that
 our analysis is incorrect? No, this data is only checked and loaded during a
 garbage collection event, it is a by product of our abuse of ``NOINLINE`` to
 create a static top-level closure.
@@ -1067,18 +1067,18 @@ that data you'll be all but guaranteed to speed up your system.
 References
 ==========
 
-.. [#] The HashMap behaves this way because of `yours truly
-       <https://github.com/haskell-unordered-containers/unordered-containers/pull/317>`__.
-       Even though the cache behavior is poor, the 16-bit base was worse because
-       it created HashMaps with a more deeply nested structure. This meant even
-       *more* pointer chasing in full cases. For the interested, you can observe
-       the effect in the data posted in the pull request I have linked.
+.. [#f1] The HashMap behaves this way because of `yours truly
+         <https://github.com/haskell-unordered-containers/unordered-containers/pull/317>`__.
+         Even though the cache behavior is poor, the 16-bit base was worse because
+         it created HashMaps with a more deeply nested structure. This meant even
+         *more* pointer chasing in full cases. For the interested, you can observe
+         the effect in the data posted in the pull request I have linked.
 
-.. [#] The `Haskell Wiki
-       <https://www.fpcomplete.com/blog/2016/05/weigh-package/>`_ page. Although
-       it has not been updated in some time.
+.. [#f2] The `Haskell Wiki
+         <https://www.fpcomplete.com/blog/2016/05/weigh-package/>`_ page. Although
+         it has not been updated in some time.
 
-.. [#] For the interested, `here
+.. [#f3] For the interested, `here
    <https://gitlab.haskell.org/ghc/ghc/-/blob/master/compiler/GHC/StgToCmm/Heap.hs?ref_type=heads#L215>`__
    is where the tag is applied and `here
    <https://gitlab.haskell.org/ghc/ghc/-/blob/master/rts/sm/Storage.h?ref_type=heads#L134>`__
diff --git a/theme.toml b/theme.toml
