diff --git a/documentation/Makefile b/documentation/Makefile index a09a995c11..c26485e6e1 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -1,40 +1,46 @@ # Generate the FreeBSD documentation # # Copyright (c) 2020-2021, The FreeBSD Documentation Project # Copyright (c) 2020-2021, Sergio Carlavilla # # 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 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 --------------------------------------------------------------- @echo Building the documentation @echo --------------------------------------------------------------- generate-books-toc: .PHONY ${PYTHON_CMD} ./tools/books-toc-parts-creator.py -l ${LANGUAGES} ${PYTHON_CMD} ./tools/books-toc-creator.py -l ${LANGUAGES} ${PYTHON_CMD} ./tools/books-toc-figures-creator.py -l ${LANGUAGES} ${PYTHON_CMD} ./tools/books-toc-tables-creator.py -l ${LANGUAGES} ${PYTHON_CMD} ./tools/books-toc-examples-creator.py -l ${LANGUAGES} run: .PHONY ${HUGO_CMD} server -D build: .PHONY ${HUGO_CMD} --minify diff --git a/website/Makefile b/website/Makefile index 85b00f6df8..c6ea6d6cef 100644 --- a/website/Makefile +++ b/website/Makefile @@ -1,35 +1,41 @@ # Generate the FreeBSD website # # Copyright (c) 2020-2021, The FreeBSD Documentation Project # Copyright (c) 2020-2021, Sergio Carlavilla # # 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 --------------------------------------------------------------- @echo Building the website @echo --------------------------------------------------------------- generate-releases: .PHONY ${PYTHON_CMD} ./tools/releases-toml.py -p ./shared/releases.adoc run: .PHONY ${HUGO_CMD} server -D build: .PHONY ${HUGO_CMD}