docs: quick fix generation script and update

The generation script updates the command documentation and especially
the index, but it always added an extra two newlines which I removed
before committing. Get rid of those spare two spaces in the generator
script, and re-run it to pick up a recent change in the "yo cache-clean"
command description.

Signed-off-by: Stephen Brennan <[email protected]>

Author: brenns10

Makefile

@@ -56,7 +56,11 @@ test:
 
 .PHONY: docs
 docs:
+	@$(PYTHON) scripts/rebuild_docs.py
 	@$(PYTHON) -m tox -e docs
+	@if [ ! -z "$$(git status docs --porcelain)" ]; then \
+	    echo "note: The docs tree is unclean"; \
+	fi
 
 .PHONY: docs-publish
 docs-publish: docs

doc/cmds/index.rst

@@ -81,7 +81,7 @@ Informative Commands:
 
 Diagnostic Commands:
 
-  - :ref:`yo_cache_clean` - Clear Yo's cache -- a good first troubleshooting step.
+  - :ref:`yo_cache_clean` - Clear Yo's caches -- a good first troubleshooting step.
   - :ref:`yo_debug` - Open up a python prompt in the context of a command.
   - :ref:`yo_help` - Show help for yo.
   - :ref:`yo_version` - Show the version of yo and check for updates.

scripts/rebuild_docs.py

@@ -4,9 +4,7 @@
 DIRECTIVE_FMT = """.. argparse::
    :module: yo.main
    :func: cmd_{stdname}_args
-   :prog: yo {name}
-
-"""
+   :prog: yo {name}"""
 
 
 def main():
@@ -25,7 +23,9 @@ def main():
             # f.write(f".. _{group}::\n\n")
             f.write(group + "\n")
             f.write("=" * len(group) + "\n\n")
-            for cmd in group_to_cmd[group]:
+            for j, cmd in enumerate(group_to_cmd[group]):
+                if j > 0:
+                    f.write("\n\n")
                 stdname = cmd.name.translate(trans)
                 directive = DIRECTIVE_FMT.format(
                     name=cmd.name,