Skip to content

Commit 4d035ad

Browse files
committed
Add message for build
Add description comment for livehtml when calling `make`
1 parent 835f01a commit 4d035ad

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

Makefile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ build: ## Set up training: Install requirements
3131
python3 -m venv . || virtualenv --clear --python=python3 .
3232
bin/python -m pip install --upgrade pip
3333
bin/pip install -r requirements.txt
34+
@echo
35+
@echo "Please activate your Python virtual environment with"
36+
@echo "source bin/activate"
3437

3538
.PHONY: html
3639
html: ## Build html
@@ -185,7 +188,7 @@ test: clean linkcheck spellcheck ## Run linkcheck, spellcheck
185188
deploy: clean html
186189

187190
.PHONY: livehtml
188-
livehtml:
191+
livehtml: ## Rebuild Sphinx documentation on changes, with live-reload in the browser
189192
cd "$(DOCS_DIR)" && sphinx-autobuild \
190193
--ignore "*.swp" \
191194
-b html . "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)

0 commit comments

Comments
 (0)