diff --git a/documentation/Makefile b/documentation/Makefile index 519f3edb65..58a42c4aee 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -1,240 +1,261 @@ # 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 # clean - removes generated files # run - serves the built documentation site for local browsing # pdf - build PDF versions of the articles and books. # # 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 # List of languages without book translations ARTICLEONLY_LANGS= bd da ko tr +# List of all languages we have content for +ALL_LANGUAGES= bd da de el en es fr hu it ja ko mn nl pl pt-br ru tr zh-cn zh-tw + LOCALBASE?= /usr/local PYTHON_CMD = ${LOCALBASE}/bin/python3 RUBY_CMD = ${LOCALBASE}/bin/ruby HUGO_CMD = ${LOCALBASE}/bin/hugo HUGO_ARGS?= --verbose --minify ASCIIDOCTORPDF_CMD= ${LOCALBASE}/bin/asciidoctor-pdf + .if defined(DOC_LANG) && !empty(DOC_LANG) LANGUAGES= ${DOC_LANG:S/,/ /g} +.if ${LANGUAGES:Men} == "" +.warning "Warning: cannot skip 'en'; adding it back" +LANGUAGES+= en +.endif .else -LANGUAGES= bd da de el en es fr hu it ja ko mn nl pl pt-br ru tr zh-cn zh-tw +LANGUAGES= ${ALL_LANGUAGES} .endif RUBYLIB = ../shared/lib .export RUBYLIB RUN_DEPENDS= ${PYTHON_CMD} \ ${HUGO_CMD} \ ${LOCALBASE}/bin/asciidoctor \ ${LOCALBASE}/bin/asciidoctor-pdf \ ${LOCALBASE}/bin/rougify .ifndef HOSTNAME . ifdef BIND .HOST=$(BIND) . else .HOST=localhost . endif .else .HOST=$(HOSTNAME) .endif # Strip the languages without articles from the list of languages we # will use to build books. BOOK_LANGS= ${LANGUAGES} .for a in ${ARTICLEONLY_LANGS} BOOK_LANGS:= ${BOOK_LANGS:N${a}} .endfor + +# Take the list of all languages, and take out the ones we have been +# asked for. We'll feed this to hugo. +SKIP_LANGS= +.for a in ${ALL_LANGUAGES} +.if ${LANGUAGES:M${a}} == "" +SKIP_LANGS+= ${a} +.endif +.endfor + .ORDER: all run .ORDER: requirements .ORDER: starting-message generate-books-toc .ORDER: starting-message build .ORDER: generate-books-toc build all: requirements starting-message generate-books-toc generate-pgpkeys-txt build run: requirements starting-message generate-books-toc generate-pgpkeys-txt run-local # clean does not call pdf-clean as that is a subset of hugo-clean clean: hugo-clean pgp-clean toc-clean requirements: .for dep in ${RUN_DEPENDS} .if !exists(${dep}) @(echo ${dep} not found, please run 'pkg install docproj'; exit 1) .endif .endfor starting-message: .PHONY @echo --------------------------------------------------------------- @echo Building the documentation + @echo included languages: ${LANGUAGES} + @echo excluded languages: ${SKIP_LANGS} @echo --------------------------------------------------------------- generate-books-toc: .PHONY ${PYTHON_CMD} ./tools/books-toc-parts-creator.py -l ${BOOK_LANGS} ${PYTHON_CMD} ./tools/books-toc-creator.py -l ${BOOK_LANGS} ${PYTHON_CMD} ./tools/books-toc-figures-creator.py -l ${BOOK_LANGS} ${PYTHON_CMD} ./tools/books-toc-tables-creator.py -l ${BOOK_LANGS} ${PYTHON_CMD} ./tools/books-toc-examples-creator.py -l ${BOOK_LANGS} generate-pgpkeys-txt: static/pgpkeys/pgpkeys.txt static/pgpkeys/pgpkeys.txt: static/pgpkeys/*key ${RUBY_CMD} ./tools/global-pgpkeys-creator.rb run-local: .PHONY - ${HUGO_CMD} server ${HUGO_ARGS} -D $(BIND:D--bind=$(BIND)) --baseURL="http://$(.HOST):1313" + HUGO_DISABLELANGUAGES="${SKIP_LANGS}" ${HUGO_CMD} server \ + ${HUGO_ARGS} -D $(BIND:D--bind=$(BIND)) --baseURL="http://$(.HOST):1313" build: .PHONY - ${HUGO_CMD} ${HUGO_ARGS} + HUGO_DISABLELANGUAGES="${SKIP_LANGS}" ${HUGO_CMD} ${HUGO_ARGS} toc-clean: .PHONY rm -f $$(${PYTHON_CMD} ./tools/books-toc-parts-creator.py -l ${BOOK_LANGS} -o) rm -f $$(${PYTHON_CMD} ./tools/books-toc-creator.py -l ${BOOK_LANGS} -o) rm -f $$(${PYTHON_CMD} ./tools/books-toc-figures-creator.py -l ${BOOK_LANGS} -o) rm -f $$(${PYTHON_CMD} ./tools/books-toc-tables-creator.py -l ${BOOK_LANGS} -o) rm -f $$(${PYTHON_CMD} ./tools/books-toc-examples-creator.py -l ${BOOK_LANGS} -o) pgp-clean: .PHONY rm -f static/pgpkeys/pgpkeys.txt hugo-clean: .PHONY rm -rf resources public # # PDF targets # Use DOC_LANG to choose the language, e.g., make DOC_LANG="en fr" pdf-books # pdf: pdf-articles pdf-books pdf-books-target: .for _lang in ${LANGUAGES:S|,| |g} .if exists(${.CURDIR}/content/${_lang}/books/) TMP += ${.CURDIR}/content/${_lang}/books/*/ .endif .endfor BOOKSDIR != echo ${TMP} pdf-articles-target: .for _lang in ${LANGUAGES:S|,| |g} .if exists(${.CURDIR}/content/${_lang}/articles/) TTMP += ${.CURDIR}/content/${_lang}/articles/*/ .endif .endfor ARTICLESDIR != echo ${TTMP} pdf-books: pdf-books-target generate-books-toc # Books build # # Notes: # pdf-theme=default-with-fallback-font is # used instead of pdf-theme=./themes/default-pdf-theme.yml because # it allows ja, ru, tr, zh-* fonts to be embedded and rendering is # better for other languages. # # asciidoctor-pdf-cjk and/or specific themes should be used for cjk # fonts .for _curpdf in ${BOOKSDIR} @mkdir -p ${.CURDIR}/public${_curpdf:S|^${.CURDIR}/content||} .if exists(${_curpdf}book.adoc) ${ASCIIDOCTORPDF_CMD} \ -r ./shared/lib/man-macro.rb \ -r ./shared/lib/man-macro.rb \ -r ./shared/lib/git-macro.rb \ -r ./shared/lib/packages-macro.rb \ -r ./shared/lib/inter-document-references-macro.rb \ -r ./shared/lib/sectnumoffset-treeprocessor.rb \ --doctype=book \ -a skip-front-matter \ -a pdf-theme=default-with-fallback-font \ -o ${.CURDIR}/public${_curpdf:S|^${.CURDIR}/content||}book.pdf \ ${_curpdf}book.adoc .else # some books use _index.adoc as main document ${ASCIIDOCTORPDF_CMD} \ -r ./shared/lib/man-macro.rb \ -r ./shared/lib/man-macro.rb \ -r ./shared/lib/git-macro.rb \ -r ./shared/lib/packages-macro.rb \ -r ./shared/lib/inter-document-references-macro.rb \ -r ./shared/lib/sectnumoffset-treeprocessor.rb \ --doctype=book \ -a skip-front-matter \ -a pdf-theme=default-with-fallback-font \ -o ${.CURDIR}/public${_curpdf:S|^${.CURDIR}/content||}book.pdf \ ${_curpdf}_index.adoc .endif .endfor pdf-articles: pdf-articles-target # Articles build .for _curpdf in ${ARTICLESDIR} @mkdir -p ${.CURDIR}/public${_curpdf:S|^${.CURDIR}/content||} ${ASCIIDOCTORPDF_CMD} \ -r ./shared/lib/man-macro.rb \ -r ./shared/lib/man-macro.rb \ -r ./shared/lib/git-macro.rb \ -r ./shared/lib/packages-macro.rb \ -r ./shared/lib/inter-document-references-macro.rb \ -r ./shared/lib/sectnumoffset-treeprocessor.rb \ --doctype=article \ -a skip-front-matter \ -a pdf-theme=default-with-fallback-font \ -o ${.CURDIR}/public${_curpdf:S|^${.CURDIR}/content||}article.pdf \ ${_curpdf}_index.adoc .if exists(${.CURDIR}/static/source/articles/${_curpdf:H:T}) cp -R ${.CURDIR}/static/source/articles/${_curpdf:H:T}/ \ ${.CURDIR}/public${_curpdf:S|^${.CURDIR}/content||} .endif .endfor pdf-clean: pdf-articles-clean pdf-books-clean pdf-books-clean: pdf-books-target toc-clean .for _curpdf in ${BOOKSDIR} rm -f ${.CURDIR}/public${_curpdf:S|^${.CURDIR}/content||}book.pdf .endfor .for _lang in ${LANGUAGES:S|,| |g} rm -fr ${.CURDIR}/public/${_lang}/books .if !exists(${.CURDIR}/public/${_lang}/articles) rm -fr ${.CURDIR}/public/${_lang} .endif .endfor @if [ -d ${.CURDIR}/public/ ]; then \ if [ -z "`ls -A ${.CURDIR}/public/`" ]; then \ rm -fr ${.CURDIR}/public; \ fi; \ fi pdf-articles-clean: pdf-articles-target .for _curpdf in ${ARTICLESDIR} rm -f ${.CURDIR}/public${_curpdf:S|^${.CURDIR}/content||}article.pdf .endfor .for _lang in ${LANGUAGES:S|,| |g} rm -fr ${.CURDIR}/public/${_lang}/articles .if !exists(${.CURDIR}/public/${_lang}/books) rm -fr ${.CURDIR}/public/${_lang} .endif .endfor @if [ -d ${.CURDIR}/public/ ]; then \ if [ -z "`ls -A ${.CURDIR}/public/`" ]; then \ rm -fr ${.CURDIR}/public; \ fi; \ fi diff --git a/website/Makefile b/website/Makefile index df9a71b985..e62d177b57 100644 --- a/website/Makefile +++ b/website/Makefile @@ -1,76 +1,101 @@ # 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 # 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 +# List of all languages we have content for +ALL_LANGUAGES= de el en es fr hu it ja nl ru tr zh-cn zh-tw + PYTHON_CMD = /usr/local/bin/python3 HUGO_CMD = /usr/local/bin/hugo HUGO_ARGS?= --verbose RUBYLIB = ../shared/lib .export RUBYLIB .ifndef HOSTNAME . ifdef BIND .HOST=$(BIND) . else .HOST=localhost . endif .else .HOST=$(HOSTNAME) .endif +.if defined(DOC_LANG) && !empty(DOC_LANG) +LANGUAGES= ${DOC_LANG:S/,/ /g} +.if ${LANGUAGES:Men} == "" +.warning "Warning: cannot skip 'en'; adding it back" +LANGUAGES+= en +.endif +.else +LANGUAGES= ${ALL_LANGUAGES} +.endif + +# Take the list of all languages, and take out the ones we have been +# asked for via DOC_LANG. We'll feed this to hugo. +SKIP_LANGS= +.for a in ${ALL_LANGUAGES} +.if ${LANGUAGES:M${a}} == "" +SKIP_LANGS+= ${a} +.endif +.endfor + .ORDER: all run .ORDER: starting-message generate-releases .ORDER: starting-message build .ORDER: generate-releases build .ORDER: build post-build .ORDER: post-build end-message all: starting-message generate-releases build post-build end-message run: starting-message generate-releases run-local clean: hugo-clean releases-clean starting-message: .PHONY @echo "---------------------------------------------------------------" @echo "Building the website started on $$(date)" + @echo " included languages: ${LANGUAGES}" + @echo " excluded languages: ${SKIP_LANGS}" @echo "---------------------------------------------------------------" end-message: .PHONY @echo "---------------------------------------------------------------" @echo "Building the website completed on $$(date)" @echo "---------------------------------------------------------------" generate-releases: data/releases.toml data/releases.toml: ${PYTHON_CMD} ./tools/releases-toml.py -p ./shared/releases.adoc run-local: .PHONY - ${HUGO_CMD} server ${HUGO_ARGS} -D $(BIND:D--bind=$(BIND)) --baseURL="http://$(.HOST):1313" + HUGO_DISABLELANGUAGES="${SKIP_LANGS}" ${HUGO_CMD} server \ + ${HUGO_ARGS} -D $(BIND:D--bind=$(BIND)) --baseURL="http://$(.HOST):1313" build: .PHONY - ${HUGO_CMD} ${HUGO_ARGS} + HUGO_DISABLELANGUAGES="${SKIP_LANGS}" ${HUGO_CMD} ${HUGO_ARGS} post-build: cgi-permissions cgi-permissions: @chmod 555 ./public/cgi/*.cgi hugo-clean: rm -fr public resources releases-clean: rm -f data/releases.toml