mirror of
https://git.FreeBSD.org/doc.git
synced 2026-06-02 19:35:07 +00:00
Sergio Carlavilla Delgado
64acd169b8
* Allow to build the documentation offline using Hugo * Fix link problems * Remove SVN entities * Fix lang problems to help weblate * Move all the AsciiDoctor translations to the shared folder to help weblate * Allow the possibility to build each document. For example each document can be edited in and watched the result in real time in VS Code or Vim/NeoVim. Breaking changes: Eliminate the possibility of building books or articles. They must be builded at the same time. This functionality will be restored when version 0.89.0 is in the repositories in a couple of weeks. Reviewed by: dbaio@ Differential Revision: https://reviews.freebsd.org/D31926
226 lines
6.6 KiB
Makefile
226 lines
6.6 KiB
Makefile
# Generate the FreeBSD documentation
|
|
#
|
|
# Copyright (c) 2020-2021, The FreeBSD Documentation Project
|
|
# Copyright (c) 2020-2021, Sergio Carlavilla <carlavilla@FreeBSD.org>
|
|
#
|
|
# 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.
|
|
# html - build HTML versions of the articles and books for
|
|
# offline use
|
|
#
|
|
# 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= bn-bd da ko tr
|
|
# List of languages without article translations
|
|
BOOKONLY_LANGS= mn
|
|
|
|
# List of all languages we have content for
|
|
ALL_LANGUAGES= bn-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
|
|
HUGO_OFFLINE_ARGS?= --environment offline --verbose --minify
|
|
ASCIIDOCTOR_CMD= ${LOCALBASE}/bin/asciidoctor
|
|
ASCIIDOCTORPDF_CMD= ${LOCALBASE}/bin/asciidoctor-pdf
|
|
|
|
.if defined(DOC_LANG) && !empty(DOC_LANG)
|
|
LANGUAGES= ${DOC_LANG:S/,/ /g}
|
|
.if ${LANGUAGES:Men} == "" && ${.TARGETS:Mpdf*} == "" && ${.TARGETS:Mhtml*} == ""
|
|
.warning "Warning: cannot skip 'en'; adding it back"
|
|
LANGUAGES+= en
|
|
.endif
|
|
.else
|
|
LANGUAGES= ${ALL_LANGUAGES}
|
|
.endif
|
|
|
|
RUBYLIB = ../shared/lib
|
|
.export RUBYLIB
|
|
|
|
RUN_DEPENDS= ${PYTHON_CMD} \
|
|
${HUGO_CMD} \
|
|
${LOCALBASE}/bin/asciidoctor \
|
|
${LOCALBASE}/bin/rougify
|
|
|
|
.ifndef HOSTNAME
|
|
. ifdef BIND
|
|
.HOST=$(BIND)
|
|
. else
|
|
.HOST=localhost
|
|
. endif
|
|
.else
|
|
.HOST=$(HOSTNAME)
|
|
.endif
|
|
|
|
# Strip the languages with only 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
|
|
|
|
# Strip the languages with only books from the list of languages we
|
|
# will use to build articles.
|
|
ARTICLE_LANGS= ${LANGUAGES}
|
|
.for a in ${BOOKONLY_LANGS}
|
|
ARTICLE_LANGS:= ${ARTICLE_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 python3'; exit 1)
|
|
.endif
|
|
.endfor
|
|
|
|
requirements-pdf:
|
|
.if !exists(${LOCALBASE}/bin/asciidoctor-pdf)
|
|
@(echo ${LOCALBASE}/bin/asciidoctor-pdf not found, please run 'pkg install rubygem-asciidoctor-pdf'; exit 1)
|
|
.endif
|
|
|
|
starting-message: .PHONY
|
|
@echo ---------------------------------------------------------------
|
|
@echo Building the documentation
|
|
@echo included languages: ${LANGUAGES}
|
|
@echo excluded languages: ${SKIP_LANGS}
|
|
@echo ---------------------------------------------------------------
|
|
|
|
generate-books-toc: .PHONY
|
|
.if !empty(BOOK_LANGS)
|
|
${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}
|
|
.endif
|
|
|
|
generate-books-toc-offline: .PHONY
|
|
.if !empty(BOOK_LANGS)
|
|
${PYTHON_CMD} ./tools/books-toc-parts-creator.py -o -l ${BOOK_LANGS}
|
|
${PYTHON_CMD} ./tools/books-toc-creator.py -o -l ${BOOK_LANGS}
|
|
${PYTHON_CMD} ./tools/books-toc-figures-creator.py -o -l ${BOOK_LANGS}
|
|
${PYTHON_CMD} ./tools/books-toc-tables-creator.py -o -l ${BOOK_LANGS}
|
|
${PYTHON_CMD} ./tools/books-toc-examples-creator.py -o -l ${BOOK_LANGS}
|
|
.endif
|
|
|
|
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_DISABLELANGUAGES="${SKIP_LANGS}" ${HUGO_CMD} server \
|
|
${HUGO_ARGS} -D $(BIND:D--bind=$(BIND)) --baseURL="http://$(.HOST):1313"
|
|
|
|
build: .PHONY
|
|
HUGO_DISABLELANGUAGES="${SKIP_LANGS}" ${HUGO_CMD} ${HUGO_ARGS}
|
|
|
|
build-offline: .PHONY
|
|
HUGO_DISABLELANGUAGES="${SKIP_LANGS}" ${HUGO_CMD} ${HUGO_OFFLINE_ARGS}
|
|
|
|
toc-clean: .PHONY
|
|
.if !empty(BOOK_LANGS)
|
|
rm -f $$(${PYTHON_CMD} ./tools/books-toc-parts-creator.py -l ${BOOK_LANGS} -p)
|
|
rm -f $$(${PYTHON_CMD} ./tools/books-toc-creator.py -l ${BOOK_LANGS} -p)
|
|
rm -f $$(${PYTHON_CMD} ./tools/books-toc-figures-creator.py -l ${BOOK_LANGS} -p)
|
|
rm -f $$(${PYTHON_CMD} ./tools/books-toc-tables-creator.py -l ${BOOK_LANGS} -p)
|
|
rm -f $$(${PYTHON_CMD} ./tools/books-toc-examples-creator.py -l ${BOOK_LANGS} -p)
|
|
.endif
|
|
|
|
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: requirements-pdf generate-books-toc
|
|
.for _lang in ${BOOK_LANGS}
|
|
./tools/asciidoctor.sh books ${_lang} pdf
|
|
.endfor
|
|
|
|
pdf-articles: requirements-pdf
|
|
.for _lang in ${ARTICLE_LANGS}
|
|
./tools/asciidoctor.sh articles ${_lang} pdf
|
|
.endfor
|
|
|
|
pdf-clean: pdf-articles-clean pdf-books-clean
|
|
|
|
pdf-books-clean:
|
|
.for _lang in ${BOOK_LANGS}
|
|
rm -fr ${.CURDIR}/public/${_lang}/books
|
|
-rmdir ${.CURDIR}/public/${_lang}
|
|
.endfor
|
|
-rmdir ${.CURDIR}/public/
|
|
|
|
pdf-articles-clean:
|
|
.for _lang in ${ARTICLE_LANGS}
|
|
rm -fr ${.CURDIR}/public/${_lang}/articles
|
|
.if !exists(${.CURDIR}/public/${_lang}/books)
|
|
rm -fr ${.CURDIR}/public/${_lang}
|
|
.endif
|
|
.endfor
|
|
-rmdir ${.CURDIR}/public
|
|
|
|
#
|
|
# HTML targets
|
|
#
|
|
html: generate-books-toc-offline build-offline html-clean-global html-clean-articles html-clean-books
|
|
|
|
html-clean: hugo-clean
|
|
|
|
html-clean-global:
|
|
rm -fr ${.CURDIR}/public/index.html
|
|
rm -rf pgpkeys js
|
|
|
|
html-clean-articles:
|
|
.for _lang in ${ARTICLE_LANGS}
|
|
rm -fr ${.CURDIR}/public/${_lang}/index.html
|
|
rm -fr ${.CURDIR}/public/${_lang}/articles/index.html
|
|
.endfor
|
|
|
|
html-clean-books:
|
|
.for _lang in ${BOOK_LANGS}
|
|
rm -fr ${.CURDIR}/public/${_lang}/books/index.html
|
|
.endfor
|