build: add tikz support

Author: doyougnu

Makefile

@@ -7,6 +7,7 @@ SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
+LATEXOPTS     = "-shell-escape"
 
 # Put it first so that "make" without argument is like "make help".
 help:

conf.py

@@ -48,6 +48,7 @@
                                          ## underscore
              , 'sphinxcontrib.bibtex'
              , 'sphinx_copybutton'
+             , 'sphinxcontrib.tikz'
              , 'sphinx_exec_directive'
              , 'conceptual_admonitions'
              ]
@@ -57,6 +58,10 @@
 todo_link_only     = False
 autosectionlabel_prefix_document = True
 
+# tikz support
+tikz_proc_suite = "pdf2svg"
+tikz_tikzlibraries = "arrows, arrows.meta"
+
 ## global links in the book that share a prefix that we've named.
 extlinks = {'userGuide': ('https://downloads.haskell.org/~ghc/9.2.4/docs/html/users_guide/%s', '%s'),
             'ghcWiki': ('https://gitlab.haskell.org/ghc/ghc/wikis/%s', '#%s'),

flake.nix

@@ -52,6 +52,15 @@
           };
         };
 
+        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;
+            };
+        };
+
     in
     flake-utils.lib.eachDefaultSystem
       (system:
@@ -60,15 +69,9 @@
                 overlays = [ press-theme-overlay
                              copy-button-overlay
                              sphinx-exec-directive-overlay
+                             tex-overlay
                            ];
               } ;
-
-            ourTexLive = pkgs.texlive.combine {
-              inherit (pkgs.texlive)
-                scheme-medium collection-xetex fncychap titlesec tabulary varwidth
-                framed capt-of wrapfig needspace dejavu-otf helvetic upquote;
-            };
-
             ## TODO use this
             fonts = pkgs.makeFontsConf { fontDirectories = [ pkgs.dejavu_fonts ]; };
 

hoh.nix

@@ -12,7 +12,6 @@ let
      # marked as broken in nixpkgs unfortunately
      # sphinx-book-theme
      ## until we have a reason for tex leave this commented out for CI
-     # ourTexLive
    ];
    nonPythonInputs = with pkgs; [ sphinx-press-theme # this comes from the overlay
                                   sphinx-copybutton  # this comes from the overlay
@@ -23,12 +22,14 @@ let
                                   ghc
                                   cabal-install
                                   git
+                                  tex-env
                                 ];
 in
 pkgs.stdenv.mkDerivation {
    pname   = "hoh";
    version = "0.0.1";
    src     = ./.;
+   phases = [ "unpackPhase" "preBuild" "buildPhase" "installPhase"];
    buildInputs = pythonInputs ++ nonPythonInputs;
 
    preBuild = ''
@@ -37,6 +38,7 @@ pkgs.stdenv.mkDerivation {
 
    buildPhase = ''
    runHook preBuild
+   export PATH="${pkgs.lib.makeBinPath (pythonInputs ++ nonPythonInputs)}:$PATH";
    SOURCE_DATE_EPOCH="$(${pkgs.coreutils}/bin/date '+%s')"
    make clean
    make ${target} SPHINXOPTS="-W"

src/glossary.rst

@@ -61,7 +61,24 @@ Glossary
 
    Boxed : Levity
 
-      A Boxed value is a value that is represented by a pointer to the heap.
+      A Boxed value is a value that is represented by a pointer to the heap. For
+      example, a value such as ``1729 :: Int`` is represented as:
+
+      ..
+         .. tikz:: An Example TikZ Directive with Caption
+            :align: left
+
+            \begin{tikzpicture}[memory graph]
+            \node[arity=2] (hd) {Cons};
+            \node
+            [arity=2,below=of hd.arg 2 center,anchor=head north]
+            (tl) {Cons};
+            \draw[ref] (hd.arg 2 center)
+            -- (tl.head north);
+            \draw[ref] (tl.arg 2 center)
+            |- ($(hd.head north)+(0,.4)$)
+            -- (hd.head north);
+            \end{tikzpicture}
 
    Cardinality Analysis