Merge pull request NixOS#10 from domenkozar/gardening

garden
zolodev · May 18, 2020 · d7469fa · d7469fa
2 parents 3aaa05a + e55008f
commit d7469fa
Show file tree

Hide file tree

Showing 18 changed files with 987 additions and 90 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 build/
+requirements_frozen.txt
 
 
diff --git a/.readthedocs.yml b/.readthedocs.yml
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
diff --git a/Makefile b/Makefile
@@ -7,11 +7,6 @@ SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = build
 
-# User-friendly check for sphinx-build
-ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
-	$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don\'t have Sphinx installed, grab it from http://sphinx-doc.org/)
-endif
-
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter

diff --git a/README.rst b/README.rst
@@ -8,3 +8,8 @@
 ==========
 
 Getting started and cookbook resources for Nix.
+
+Contributing
+------------
+
+Run `./live` and open a browser at https://localhost:5500. As you make changes, the browser should auto-reload.
diff --git a/live b/live
@@ -0,0 +1,2 @@
+# TODO: https://github.com/nix-community/pypi2nix/issues/432
+PATH=$PATH:$(nix-build requirements.nix)/bin nix-shell requirements.nix --run "python live.py"
diff --git a/live.py b/live.py
@@ -0,0 +1,12 @@
+from livereload import Server, shell
+
+server = Server()
+
+build_docs = shell("make html")
+
+print("Doing an initial build of the docs...")
+build_docs()
+
+server.watch("source/*.rst", build_docs)
+server.watch("source/**/*.rst", build_docs)
+server.serve(root="build/html")