diff --git a/documentation/Makefile b/documentation/Makefile --- 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 @@ 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 --------------------------------------------------------------- diff --git a/website/Makefile b/website/Makefile --- a/website/Makefile +++ b/website/Makefile @@ -6,19 +6,25 @@ # Targets intended for use on the command line # # all (default) - generate the releases.toml and compile all the website -# generate - generate the releases.toml and build all the website +# run - serves the built website for local browsing +# +# The run target uses hugo's built-in webserver to make the built website +# available for local browsing. The website 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 PYTHON_CMD = /usr/local/bin/python3.7 HUGO_CMD = /usr/local/bin/hugo +.ORDER: all run + .ORDER: starting-message generate-books-toc .ORDER: starting-message build .ORDER: generate-books-toc build -all: starting-message generate-releases run -generate: starting-message generate-releases build .PHONY +all: starting-message generate-releases build starting-message: .PHONY @echo ---------------------------------------------------------------