chore: Add venv to .gitignore and document use in Eldev.

szermatt · Oct 8, 2024 · 4723ea1 · 4723ea1
1 parent a4c6f23
commit 4723ea1
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,7 @@
 /docs/build
 /dist
 /dir
+/venv
 mistty.info
 .cask
 *-autoloads.el*

diff --git a/Eldev b/Eldev
@@ -77,7 +77,12 @@
     (write-file "mistty.texi")))
 
 (eldev-defcommand mistty-html-doc (&rest parameters)
-  "Generate documentation HTML into docs/build/html."
+  "Generate documentation HTML into docs/build/html.
+
+First install Sphinx with:
+  python3 -m venv venv
+  . venv/bin/activate
+  pip3 install -r docs/requirements.txt"
   :command        documentation
   :aliases        (html)
   (eldev-call-process "sphinx-build" '("-M" "html" "docs/source" "docs/build")
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,6 +3,7 @@ @@
     /docs/build
     /dist
     /dir
+    /venv
     mistty.info
     .cask
     *-autoloads.el*
@@ Expand Down @@