Start the docs for persist

doc/index.rst

@@ -23,6 +23,7 @@ Contents
 
    python
    guile
+   persist
 
 ----
 

doc/persist.rst

@@ -0,0 +1 @@
+../immer/extra/persist/README.rst

flake.nix

@@ -25,11 +25,16 @@
       url = "github:arximboldi/cereal";
       flake = false;
     };
+    docs-nixpkgs = {
+      url = "github:NixOS/nixpkgs/d0d905668c010b65795b57afdf7f0360aac6245b";
+      flake = false;
+    };
   };
 
   outputs = {
     self,
     nixpkgs,
+    docs-nixpkgs,
     flake-utils,
     flake-compat,
     pre-commit-hooks,
@@ -114,6 +119,35 @@
           '';
       };
 
+      devShells.docs = let
+        docsPkgs = import docs-nixpkgs {inherit system;};
+        docs = docsPkgs.callPackage ./nix/docs.nix {};
+      in
+        pkgs.mkShell {
+          packages = [
+            pkgs.just
+            pkgs.fzf
+            pkgs.starship
+            pkgs.cmake
+            pkgs.ninja
+
+            docsPkgs.doxygen
+            (docsPkgs.python.withPackages (ps: [
+              ps.sphinx
+              docs.breathe
+              docs.recommonmark
+            ]))
+          ];
+
+          shellHook =
+            self.checks.${system}.pre-commit-check.shellHook
+            + "\n"
+            + ''
+              alias j=just
+              eval "$(starship init bash)"
+            '';
+        };
+
       packages = {
         immer = let
           inherit (gitignore.lib) gitignoreSource;

immer/extra/persist/README.rst

@@ -0,0 +1,5 @@
+
+Persist
+===============
+
+This library allows to preserve structural sharing of immer containers while serializing and deserializing them.

justfile

@@ -30,3 +30,15 @@ mk-build-asan: (_mk-dir build-asan-path)
 
 run-tests-asan:
     cd {{ build-asan-path }} ; ninja tests && ninja test
+
+build-docs-path := "build-docs-" + os() + "-" + arch()
+
+[linux]
+mk-build-docs: (_mk-dir build-docs-path)
+    rm -rf doc/_build
+    rm -rf doc/_doxygen
+    cmake -B {{ build-docs-path }} -G Ninja -Dimmer_BUILD_TESTS=off
+
+[linux]
+build-docs:
+    cmake --build {{ build-docs-path }} --target docs