doctester: repl examples

NixOS · Aug 14, 2023 · 6c5715b · 6c5715b
1 parent 0d6c103
commit 6c5715b
Show file tree

Hide file tree

Showing 19 changed files with 2,104 additions and 2 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,10 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+
+[*.rs]
+indent_style = space
+indent_size = 4
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -21,5 +21,7 @@ jobs:
       run: nix-build
     - name: Linkcheck
       run: nix-shell --run "make linkcheck"
+    - name: Run doctests
+      run: nix run .#doctests
     - name: Run code block tests
       run: nix-shell --run "./run_code_block_tests.sh"
diff --git a/README.md b/README.md
@@ -9,12 +9,22 @@
 
 Official documentation for getting things done with Nix.
 
-## Contributing
+## Development daemon
 
 Run `./live` and open a browser at <http://localhost:5500>.
 
 As you make changes your browser should auto-reload within a few seconds.
 
+## Guidelines
+
 For contents and style see [contribution guide](CONTRIBUTING.md).
 
 For syntax see [RST/Sphinx Cheatsheet](https://sphinx-tutorial.readthedocs.io/cheatsheet/).
+
+## Doctests
+
+Must be run in the repository root.
+
+- Single run: `nix run .#doctests`
+- Daemon: `nix run .#watch-doctests`
+
diff --git a/doctester/.gitignore b/doctester/.gitignore
@@ -0,0 +1 @@
+/target