aboutsummaryrefslogtreecommitdiff
path: root/documentation/Makefile
diff options
context:
space:
mode:
authorKyle Evans <kevans@FreeBSD.org>2021-01-28 04:22:48 +0000
committerKyle Evans <kevans@FreeBSD.org>2021-01-29 03:15:10 +0000
commit127d3f2965db2f4fad12bfabeeec9370f0972e92 (patch)
treea6efc821f333a8e1bddab4013899e3dd6b5bb370 /documentation/Makefile
parent885316d9e8d388a3a5b5d15972c9e81c46f918fb (diff)
Diffstat (limited to 'documentation/Makefile')
-rw-r--r--documentation/Makefile12
1 files changed, 9 insertions, 3 deletions
diff --git a/documentation/Makefile b/documentation/Makefile
index a09a995c11..c26485e6e1 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -6,7 +6,12 @@
# Targets intended for use on the command line
#
# all (default) - generate the books TOC and compile all the documentation
-# generate - generate the books TOC and build all the documentation
+# run - serves the built documentation site for local browsing
+#
+# The run target uses hugo's built-in webserver to make the documentation site
+# available for local browsing. The documentation should have been built prior
+# to attempting to use the `run` target. By default, hugo will start its
+# webserver on port 1313.
MAINTAINER=carlavilla@FreeBSD.org
@@ -14,12 +19,13 @@ PYTHON_CMD = /usr/local/bin/python3.7
HUGO_CMD = /usr/local/bin/hugo
LANGUAGES = en,es,pt-br,de,ja,zh-cn,zh-tw,ru,el,hu,it,mn,nl,pl,fr
+.ORDER: all run
+
.ORDER: starting-message generate-books-toc
.ORDER: starting-message build
.ORDER: generate-books-toc build
-all: starting-message generate-books-toc run
-generate: starting-message generate-books-toc build .PHONY
+all: starting-message generate-books-toc build
starting-message: .PHONY
@echo ---------------------------------------------------------------