qiurui
/
freebsd-doc
mirror of https://git.FreeBSD.org/doc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
freebsd-doc/documentation/Makefile

284 lines
7.9 KiB
Makefile
Raw Normal View History

Migrate doc to Hugo/AsciiDoctor I'm very pleased to announce the release of our new website and documentation using the new toolchain with Hugo and AsciiDoctor. To get more information about the new toolchain please read the FreeBSD Documentation Project Primer[1], Hugo docs[2] and AsciiDoctor docs[3]. Acknowledgment: Benedict Reuschling <bcr@> Glen Barber <gjb@> Hiroki Sato <hrs@> Li-Wen Hsu <lwhsu@> Sean Chittenden <seanc@> The FreeBSD Foundation [1] https://docs.FreeBSD.org/en/books/fdp-primer/ [2] https://gohugo.io/documentation/ [3] https://docs.asciidoctor.org/home/ Approved by: doceng, core
2021-01-25 23:31:29 +00:00
# Generate the FreeBSD documentation
#
Upgrade copyright years
2025-01-07 16:32:54 +00:00
# Copyright (c) 2020-2025, The FreeBSD Documentation Project
# Copyright (c) 2020-2025, Sergio Carlavilla <carlavilla@FreeBSD.org>
Migrate doc to Hugo/AsciiDoctor I'm very pleased to announce the release of our new website and documentation using the new toolchain with Hugo and AsciiDoctor. To get more information about the new toolchain please read the FreeBSD Documentation Project Primer[1], Hugo docs[2] and AsciiDoctor docs[3]. Acknowledgment: Benedict Reuschling <bcr@> Glen Barber <gjb@> Hiroki Sato <hrs@> Li-Wen Hsu <lwhsu@> Sean Chittenden <seanc@> The FreeBSD Foundation [1] https://docs.FreeBSD.org/en/books/fdp-primer/ [2] https://gohugo.io/documentation/ [3] https://docs.asciidoctor.org/home/ Approved by: doceng, core
2021-01-25 23:31:29 +00:00
#
# Targets intended for use on the command line
#
Documentation Portal - Makefile: Improve all target comment PR: 274073 Sponsored by: Daifressh
2023-09-27 17:32:55 +00:00
# all (default) - generate books and articles without generating the
# PDFs or EPUBs
Add a "clean" target. Reviewed by: ygy Differential Revision: https://reviews.freebsd.org/D30925
2021-06-29 08:57:30 +00:00
# clean - removes generated files
documentation/Makefile: update lead-in note on common targets Approved by: blackend (mentor)
2021-06-01 12:32:09 +00:00
# run - serves the built documentation site for local browsing
# pdf - build PDF versions of the articles and books.
documentation/Makefile: Add HTML targets for offline use Addition of various HTML targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en fr" html-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. The produced files do not include some metadatas, they are intended for offline use. Reviewed by: ceri Differential Revision: https://reviews.freebsd.org/D30718
2021-07-14 10:28:49 +00:00
# html - build HTML versions of the articles and books for
Documentation Portal - Makefile: Improve all target comment PR: 274073 Sponsored by: Daifressh
2023-09-27 17:32:55 +00:00
# offline use.
# If variable DOC_HTML_ARCHIVE is set, all documents will be
# archived/compressed, and only these files will be kept in the
# public directory.
documentation: Add experimental support for EPUB output
2021-11-06 13:53:31 +00:00
# epub - build EPUB versions of the articles and books (Experimental).
build: remove generate target, split run out This ensures that `make all` will never try to run the internal server. Instead, the user can run it manually if they need to. Reviewed-by: gjb, hrs Differential-Revision: https://reviews.freebsd.org/D28384
2021-01-28 04:22:48 +00:00
#
# 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.
Migrate doc to Hugo/AsciiDoctor I'm very pleased to announce the release of our new website and documentation using the new toolchain with Hugo and AsciiDoctor. To get more information about the new toolchain please read the FreeBSD Documentation Project Primer[1], Hugo docs[2] and AsciiDoctor docs[3]. Acknowledgment: Benedict Reuschling <bcr@> Glen Barber <gjb@> Hiroki Sato <hrs@> Li-Wen Hsu <lwhsu@> Sean Chittenden <seanc@> The FreeBSD Foundation [1] https://docs.FreeBSD.org/en/books/fdp-primer/ [2] https://gohugo.io/documentation/ [3] https://docs.asciidoctor.org/home/ Approved by: doceng, core
2021-01-25 23:31:29 +00:00
MAINTAINER=carlavilla@FreeBSD.org
documentation/Makefile: use all languages by default Previously we only added languages with content in books/ to the LANGUAGES variable because they would cause the build to fail, and this meant that they did not get PDFs built either. It also meant they could not be included in DOC_LANG as this then break the build. Add a new variable, ARTICLEONLY_LANGS, to identify them and, with the safety of the new logic in the tools/book-toc*py scripts to warn if we miss one, build all of the content by default under the PDF target. This also makes DOC_LANG safe to use even if there isn't a book in that language.
2021-06-16 16:42:28 +00:00
# List of languages without book translations
Add Indonesian translation of Mailing List FAQ article As this is a new language in the FreeBSD documentation, other files/translations were added together. Reviewed by: dbaio (translating it back to English) Approved by: dbaio (doceng) Differential Revision: https://reviews.freebsd.org/D34599 Co-authored-by: Danilo G. Baio <dbaio@FreeBSD.org>
2022-03-19 10:52:29 +00:00
ARTICLEONLY_LANGS= bn-bd da id ko tr
documentation/Makefile: Add HTML targets for offline use Addition of various HTML targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en fr" html-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. The produced files do not include some metadatas, they are intended for offline use. Reviewed by: ceri Differential Revision: https://reviews.freebsd.org/D30718
2021-07-14 10:28:49 +00:00
# List of languages without article translations
BOOKONLY_LANGS= mn
documentation/Makefile: use all languages by default Previously we only added languages with content in books/ to the LANGUAGES variable because they would cause the build to fail, and this meant that they did not get PDFs built either. It also meant they could not be included in DOC_LANG as this then break the build. Add a new variable, ARTICLEONLY_LANGS, to identify them and, with the safety of the new logic in the tools/book-toc*py scripts to warn if we miss one, build all of the content by default under the PDF target. This also makes DOC_LANG safe to use even if there isn't a book in that language.
2021-06-16 16:42:28 +00:00
Makefile: If DOC_LANG is set, stop hugo from building other languages. The hugo driven targets currently build all the languages despite anything set in DOC_LANG or elsewhere. Have DOC_LANG drive HUGO_DISABLELANGUAGES in order to stop that. With the caveat that: hugo always has to build en as it's the default language, so add a warning if it's left out before adding it back in. Reviewed by: dbaio, ygy Differential Revision: https://reviews.freebsd.org/D30796
2021-06-30 11:39:33 +00:00
# List of all languages we have content for
Add Indonesian translation of Mailing List FAQ article As this is a new language in the FreeBSD documentation, other files/translations were added together. Reviewed by: dbaio (translating it back to English) Approved by: dbaio (doceng) Differential Revision: https://reviews.freebsd.org/D34599 Co-authored-by: Danilo G. Baio <dbaio@FreeBSD.org>
2022-03-19 10:52:29 +00:00
ALL_LANGUAGES= bn-bd da de el en es fr hu id it ja ko mn nl pl pt-br ru tr zh-cn zh-tw
Makefile: If DOC_LANG is set, stop hugo from building other languages. The hugo driven targets currently build all the languages despite anything set in DOC_LANG or elsewhere. Have DOC_LANG drive HUGO_DISABLELANGUAGES in order to stop that. With the caveat that: hugo always has to build en as it's the default language, so add a warning if it's left out before adding it back in. Reviewed by: dbaio, ygy Differential Revision: https://reviews.freebsd.org/D30796
2021-06-30 11:39:33 +00:00
documentation/Makefile: add requirements target Add the requirements target in order to prompt the user to install the needed dependencies to be able to run `make run` successfully. Reviewed by: ygy, debdrup, imp Approved by: ygy (doc) Differential Revision: https://reviews.freebsd.org/D30161
2021-05-07 14:02:37 +00:00
LOCALBASE?= /usr/local
Update build instructions for macOS Approved by: carlavilla@ Reviewed by: Jose Luis Duran <jlduran_gmail.com> Differential Revision: https://reviews.freebsd.org/D37143
2022-11-02 21:40:13 +00:00
USE_RUBYGEMS?= NO
GEM_PATH?=
documentation/Makefile: add requirements target Add the requirements target in order to prompt the user to install the needed dependencies to be able to run `make run` successfully. Reviewed by: ygy, debdrup, imp Approved by: ygy (doc) Differential Revision: https://reviews.freebsd.org/D30161
2021-05-07 14:02:37 +00:00
Update build instructions for macOS Approved by: carlavilla@ Reviewed by: Jose Luis Duran <jlduran_gmail.com> Differential Revision: https://reviews.freebsd.org/D37143
2022-11-02 21:40:13 +00:00
.if ${USE_RUBYGEMS} == "YES"
GEMBASE?= ${GEM_PATH}
.else
GEMBASE?= ${LOCALBASE}
.endif
FDP: Upgrade MacOS build instructions - Upgrade MacOS build instructions - Remove tip about use Hugo 0.90 or higher Differential Revision: https://reviews.freebsd.org/D41036
2023-07-14 14:36:01 +00:00
RUBY_CMD ?= ${LOCALBASE}/bin/ruby
documentation/Makefile: add requirements target Add the requirements target in order to prompt the user to install the needed dependencies to be able to run `make run` successfully. Reviewed by: ygy, debdrup, imp Approved by: ygy (doc) Differential Revision: https://reviews.freebsd.org/D30161
2021-05-07 14:02:37 +00:00
HUGO_CMD = ${LOCALBASE}/bin/hugo
Remove build verbosity by default This way, it will be easier to identify warnings and errors from Hugo for anyone when working and building the website or the documentation portal. On CI, the builds have verbose and debug options enabled: ``` $ cd doc $ make HUGO_ARGS="--verbose --debug" ```
2023-01-21 00:57:44 +00:00
HUGO_ARGS?= --minify
doc: Remove build verbosity for the offline assets build The same has been made for the HTML build on 8548086.
2023-07-28 01:39:20 +00:00
HUGO_OFFLINE_ARGS?= --environment offline --minify
Update build instructions for macOS Approved by: carlavilla@ Reviewed by: Jose Luis Duran <jlduran_gmail.com> Differential Revision: https://reviews.freebsd.org/D37143
2022-11-02 21:40:13 +00:00
ROUGIFY_CMD= ${GEMBASE}/bin/rougify
ASCIIDOCTOR_CMD= ${GEMBASE}/bin/asciidoctor
ASCIIDOCTORPDF_CMD= ${GEMBASE}/bin/asciidoctor-pdf
ASCIIDOCTOREPUB3_CMD= ${GEMBASE}/bin/asciidoctor-epub3
Build offline documentation using Hugo and other improvements * 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
2021-11-03 16:39:08 +00:00
documentation/Makefile: Add PDF targets. Addition of various PDF targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en,fr" pdf-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. Reviewed by: ceri, gjb, dbaio Differential Revision: <https://reviews.freebsd.org/D30331>
2021-05-31 16:16:55 +00:00
.if defined(DOC_LANG) && !empty(DOC_LANG)
documentation/Makefile: use all languages by default Previously we only added languages with content in books/ to the LANGUAGES variable because they would cause the build to fail, and this meant that they did not get PDFs built either. It also meant they could not be included in DOC_LANG as this then break the build. Add a new variable, ARTICLEONLY_LANGS, to identify them and, with the safety of the new logic in the tools/book-toc*py scripts to warn if we miss one, build all of the content by default under the PDF target. This also makes DOC_LANG safe to use even if there isn't a book in that language.
2021-06-16 16:42:28 +00:00
LANGUAGES= ${DOC_LANG:S/,/ /g}
documentation/Makefile: Add HTML targets for offline use Addition of various HTML targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en fr" html-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. The produced files do not include some metadatas, they are intended for offline use. Reviewed by: ceri Differential Revision: https://reviews.freebsd.org/D30718
2021-07-14 10:28:49 +00:00
.if ${LANGUAGES:Men} == "" && ${.TARGETS:Mpdf*} == "" && ${.TARGETS:Mhtml*} == ""
Makefile: If DOC_LANG is set, stop hugo from building other languages. The hugo driven targets currently build all the languages despite anything set in DOC_LANG or elsewhere. Have DOC_LANG drive HUGO_DISABLELANGUAGES in order to stop that. With the caveat that: hugo always has to build en as it's the default language, so add a warning if it's left out before adding it back in. Reviewed by: dbaio, ygy Differential Revision: https://reviews.freebsd.org/D30796
2021-06-30 11:39:33 +00:00
.warning "Warning: cannot skip 'en'; adding it back"
LANGUAGES+= en
.endif
documentation/Makefile: Add PDF targets. Addition of various PDF targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en,fr" pdf-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. Reviewed by: ceri, gjb, dbaio Differential Revision: <https://reviews.freebsd.org/D30331>
2021-05-31 16:16:55 +00:00
.else
Makefile: If DOC_LANG is set, stop hugo from building other languages. The hugo driven targets currently build all the languages despite anything set in DOC_LANG or elsewhere. Have DOC_LANG drive HUGO_DISABLELANGUAGES in order to stop that. With the caveat that: hugo always has to build en as it's the default language, so add a warning if it's left out before adding it back in. Reviewed by: dbaio, ygy Differential Revision: https://reviews.freebsd.org/D30796
2021-06-30 11:39:33 +00:00
LANGUAGES= ${ALL_LANGUAGES}
documentation/Makefile: Add PDF targets. Addition of various PDF targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en,fr" pdf-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. Reviewed by: ceri, gjb, dbaio Differential Revision: <https://reviews.freebsd.org/D30331>
2021-05-31 16:16:55 +00:00
.endif
Allow building the documentation and the website with upstream hugo When we build our documentation and website we use a hacked version of www/gohugo that allows for arbitrary asciidoc extensions. This was added as a patch in r562416. The suggested pull request[1] this patch was based on was not accepted "as is" and only allows the execution of extensions in Ruby's $LOAD_PATH. With these changes, we add our <docroot>shared/lib directory to Ruby's library directory so we can load our custom extensions. This also allows building the docs and website outsite FreeBSD using upstream and unmodified tools. Tested with the upcoming vanilla gohugo-0.82 provided by gohugo's maintainer. [1] https://github.com/gohugoio/hugo/pull/8131 Patch by: fernape@ Differential Revision: https://reviews.freebsd.org/D29410
2021-03-31 18:44:54 +00:00
RUBYLIB = ../shared/lib
.export RUBYLIB
Migrate doc to Hugo/AsciiDoctor I'm very pleased to announce the release of our new website and documentation using the new toolchain with Hugo and AsciiDoctor. To get more information about the new toolchain please read the FreeBSD Documentation Project Primer[1], Hugo docs[2] and AsciiDoctor docs[3]. Acknowledgment: Benedict Reuschling <bcr@> Glen Barber <gjb@> Hiroki Sato <hrs@> Li-Wen Hsu <lwhsu@> Sean Chittenden <seanc@> The FreeBSD Foundation [1] https://docs.FreeBSD.org/en/books/fdp-primer/ [2] https://gohugo.io/documentation/ [3] https://docs.asciidoctor.org/home/ Approved by: doceng, core
2021-01-25 23:31:29 +00:00
New Documentation Portal I'm very pleased to announce the release of our new Documentation Portal. Key features: * Responsive * Modern design * Theme support: Light, Dark, High contrast * Removed Python dependency Acknowledgment: * Alexander Leidinger <netchild (at) FreeBSD.org> * Baptiste Daroussin <bapt (at) FreeBSD.org> * Benedict Reuschling <bcr (at) freebsd.org> * Daniel Ebdrup Jensen <debdrup (at) FreeBSD.org> * Danilo G. Baio <dbaio (at) FreeBSD.org> * Dave Cottlehuber <dch (at) FreeBSD.org> * Ed Maste <emaste (at) FreeBSD.org> * Fernando Apesteguía <fernape (at) FreeBSD.org> * Pedro Giffuni <pfg (at) FreeBSD.org> * Joseph Mingrone <jrm (at) ftfl.ca> * Rocky Hotas <rockyhotas (at) firemail.cc> * Pau Amma <pauamma (at) gundo.com> * The FreeBSD Foundation Approved by: core, doceng
2021-12-11 09:57:33 +00:00
RUN_DEPENDS= ${HUGO_CMD} \
Update build instructions for macOS Approved by: carlavilla@ Reviewed by: Jose Luis Duran <jlduran_gmail.com> Differential Revision: https://reviews.freebsd.org/D37143
2022-11-02 21:40:13 +00:00
${ASCIIDOCTOR_CMD} \
${ROUGIFY_CMD}
documentation/Makefile: add requirements target Add the requirements target in order to prompt the user to install the needed dependencies to be able to run `make run` successfully. Reviewed by: ygy, debdrup, imp Approved by: ygy (doc) Differential Revision: https://reviews.freebsd.org/D30161
2021-05-07 14:02:37 +00:00
Makefiles: Add a conditional check on HOSTNAME variable In order for hugo to build all links correctly, it is necessary to define baseURL - but in order to do this, we need some way of adding a hostname. This change adds the HOSTNAME variable to accomplish this. Another advantage is that if HOSTNAME is set to something other than localhost, hugo can be run on a different (more powerful) machine which can shorten the time it takes to build. A note about this will need to be added to the FDP later.
2021-02-14 21:39:20 +00:00
.ifndef HOSTNAME
hugo server: Fix bind and hostname parameters When BIND variable is defined, baseURL/.HOST should not be set to localhost by default. Reported by: imp Reviewed by: imp, ceri, blackend Differential Revision: https://reviews.freebsd.org/D30656
2021-06-05 20:25:46 +00:00
. ifdef BIND
.HOST=$(BIND)
. else
.HOST=localhost
. endif
Makefiles: Add a conditional check on HOSTNAME variable In order for hugo to build all links correctly, it is necessary to define baseURL - but in order to do this, we need some way of adding a hostname. This change adds the HOSTNAME variable to accomplish this. Another advantage is that if HOSTNAME is set to something other than localhost, hugo can be run on a different (more powerful) machine which can shorten the time it takes to build. A note about this will need to be added to the FDP later.
2021-02-14 21:39:20 +00:00
.else
hugo server: Fix bind and hostname parameters When BIND variable is defined, baseURL/.HOST should not be set to localhost by default. Reported by: imp Reviewed by: imp, ceri, blackend Differential Revision: https://reviews.freebsd.org/D30656
2021-06-05 20:25:46 +00:00
.HOST=$(HOSTNAME)
Makefiles: Add a conditional check on HOSTNAME variable In order for hugo to build all links correctly, it is necessary to define baseURL - but in order to do this, we need some way of adding a hostname. This change adds the HOSTNAME variable to accomplish this. Another advantage is that if HOSTNAME is set to something other than localhost, hugo can be run on a different (more powerful) machine which can shorten the time it takes to build. A note about this will need to be added to the FDP later.
2021-02-14 21:39:20 +00:00
.endif
documentation/Makefile: Add HTML targets for offline use Addition of various HTML targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en fr" html-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. The produced files do not include some metadatas, they are intended for offline use. Reviewed by: ceri Differential Revision: https://reviews.freebsd.org/D30718
2021-07-14 10:28:49 +00:00
# Strip the languages with only articles from the list of languages we
documentation/Makefile: use all languages by default Previously we only added languages with content in books/ to the LANGUAGES variable because they would cause the build to fail, and this meant that they did not get PDFs built either. It also meant they could not be included in DOC_LANG as this then break the build. Add a new variable, ARTICLEONLY_LANGS, to identify them and, with the safety of the new logic in the tools/book-toc*py scripts to warn if we miss one, build all of the content by default under the PDF target. This also makes DOC_LANG safe to use even if there isn't a book in that language.
2021-06-16 16:42:28 +00:00
# will use to build books.
BOOK_LANGS= ${LANGUAGES}
.for a in ${ARTICLEONLY_LANGS}
BOOK_LANGS:= ${BOOK_LANGS:N${a}}
.endfor
documentation/Makefile: Add HTML targets for offline use Addition of various HTML targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en fr" html-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. The produced files do not include some metadatas, they are intended for offline use. Reviewed by: ceri Differential Revision: https://reviews.freebsd.org/D30718
2021-07-14 10:28:49 +00:00
# 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
Makefile: If DOC_LANG is set, stop hugo from building other languages. The hugo driven targets currently build all the languages despite anything set in DOC_LANG or elsewhere. Have DOC_LANG drive HUGO_DISABLELANGUAGES in order to stop that. With the caveat that: hugo always has to build en as it's the default language, so add a warning if it's left out before adding it back in. Reviewed by: dbaio, ygy Differential Revision: https://reviews.freebsd.org/D30796
2021-06-30 11:39:33 +00:00
# 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
build: remove generate target, split run out This ensures that `make all` will never try to run the internal server. Instead, the user can run it manually if they need to. Reviewed-by: gjb, hrs Differential-Revision: https://reviews.freebsd.org/D28384
2021-01-28 04:22:48 +00:00
.ORDER: all run
documentation/Makefile: add requirements target Add the requirements target in order to prompt the user to install the needed dependencies to be able to run `make run` successfully. Reviewed by: ygy, debdrup, imp Approved by: ygy (doc) Differential Revision: https://reviews.freebsd.org/D30161
2021-05-07 14:02:37 +00:00
.ORDER: requirements
New Documentation Portal I'm very pleased to announce the release of our new Documentation Portal. Key features: * Responsive * Modern design * Theme support: Light, Dark, High contrast * Removed Python dependency Acknowledgment: * Alexander Leidinger <netchild (at) FreeBSD.org> * Baptiste Daroussin <bapt (at) FreeBSD.org> * Benedict Reuschling <bcr (at) freebsd.org> * Daniel Ebdrup Jensen <debdrup (at) FreeBSD.org> * Danilo G. Baio <dbaio (at) FreeBSD.org> * Dave Cottlehuber <dch (at) FreeBSD.org> * Ed Maste <emaste (at) FreeBSD.org> * Fernando Apesteguía <fernape (at) FreeBSD.org> * Pedro Giffuni <pfg (at) FreeBSD.org> * Joseph Mingrone <jrm (at) ftfl.ca> * Rocky Hotas <rockyhotas (at) firemail.cc> * Pau Amma <pauamma (at) gundo.com> * The FreeBSD Foundation Approved by: core, doceng
2021-12-11 09:57:33 +00:00
.ORDER: starting-message
build: slap some .ORDER on targets This ensures that the build still generally works if one specifies jobs and multiple targets at the same time. Reviewed-by: gjb, hrs Differential-Revision: https://reviews.freebsd.org/D28382
2021-01-27 16:05:58 +00:00
.ORDER: starting-message build
New Documentation Portal I'm very pleased to announce the release of our new Documentation Portal. Key features: * Responsive * Modern design * Theme support: Light, Dark, High contrast * Removed Python dependency Acknowledgment: * Alexander Leidinger <netchild (at) FreeBSD.org> * Baptiste Daroussin <bapt (at) FreeBSD.org> * Benedict Reuschling <bcr (at) freebsd.org> * Daniel Ebdrup Jensen <debdrup (at) FreeBSD.org> * Danilo G. Baio <dbaio (at) FreeBSD.org> * Dave Cottlehuber <dch (at) FreeBSD.org> * Ed Maste <emaste (at) FreeBSD.org> * Fernando Apesteguía <fernape (at) FreeBSD.org> * Pedro Giffuni <pfg (at) FreeBSD.org> * Joseph Mingrone <jrm (at) ftfl.ca> * Rocky Hotas <rockyhotas (at) firemail.cc> * Pau Amma <pauamma (at) gundo.com> * The FreeBSD Foundation Approved by: core, doceng
2021-12-11 09:57:33 +00:00
.ORDER: build
build: slap some .ORDER on targets This ensures that the build still generally works if one specifies jobs and multiple targets at the same time. Reviewed-by: gjb, hrs Differential-Revision: https://reviews.freebsd.org/D28382
2021-01-27 16:05:58 +00:00
New Documentation Portal I'm very pleased to announce the release of our new Documentation Portal. Key features: * Responsive * Modern design * Theme support: Light, Dark, High contrast * Removed Python dependency Acknowledgment: * Alexander Leidinger <netchild (at) FreeBSD.org> * Baptiste Daroussin <bapt (at) FreeBSD.org> * Benedict Reuschling <bcr (at) freebsd.org> * Daniel Ebdrup Jensen <debdrup (at) FreeBSD.org> * Danilo G. Baio <dbaio (at) FreeBSD.org> * Dave Cottlehuber <dch (at) FreeBSD.org> * Ed Maste <emaste (at) FreeBSD.org> * Fernando Apesteguía <fernape (at) FreeBSD.org> * Pedro Giffuni <pfg (at) FreeBSD.org> * Joseph Mingrone <jrm (at) ftfl.ca> * Rocky Hotas <rockyhotas (at) firemail.cc> * Pau Amma <pauamma (at) gundo.com> * The FreeBSD Foundation Approved by: core, doceng
2021-12-11 09:57:33 +00:00
all: requirements starting-message generate-pgpkeys-txt build
run: requirements starting-message generate-pgpkeys-txt run-local
documentation/Makefile: add requirements target Add the requirements target in order to prompt the user to install the needed dependencies to be able to run `make run` successfully. Reviewed by: ygy, debdrup, imp Approved by: ygy (doc) Differential Revision: https://reviews.freebsd.org/D30161
2021-05-07 14:02:37 +00:00
Add a "clean" target. Reviewed by: ygy Differential Revision: https://reviews.freebsd.org/D30925
2021-06-29 08:57:30 +00:00
# clean does not call pdf-clean as that is a subset of hugo-clean
New Documentation Portal I'm very pleased to announce the release of our new Documentation Portal. Key features: * Responsive * Modern design * Theme support: Light, Dark, High contrast * Removed Python dependency Acknowledgment: * Alexander Leidinger <netchild (at) FreeBSD.org> * Baptiste Daroussin <bapt (at) FreeBSD.org> * Benedict Reuschling <bcr (at) freebsd.org> * Daniel Ebdrup Jensen <debdrup (at) FreeBSD.org> * Danilo G. Baio <dbaio (at) FreeBSD.org> * Dave Cottlehuber <dch (at) FreeBSD.org> * Ed Maste <emaste (at) FreeBSD.org> * Fernando Apesteguía <fernape (at) FreeBSD.org> * Pedro Giffuni <pfg (at) FreeBSD.org> * Joseph Mingrone <jrm (at) ftfl.ca> * Rocky Hotas <rockyhotas (at) firemail.cc> * Pau Amma <pauamma (at) gundo.com> * The FreeBSD Foundation Approved by: core, doceng
2021-12-11 09:57:33 +00:00
clean: hugo-clean pgp-clean
Add a "clean" target. Reviewed by: ygy Differential Revision: https://reviews.freebsd.org/D30925
2021-06-29 08:57:30 +00:00
documentation/Makefile: add requirements target Add the requirements target in order to prompt the user to install the needed dependencies to be able to run `make run` successfully. Reviewed by: ygy, debdrup, imp Approved by: ygy (doc) Differential Revision: https://reviews.freebsd.org/D30161
2021-05-07 14:02:37 +00:00
requirements:
.for dep in ${RUN_DEPENDS}
.if !exists(${dep})
New Documentation Portal I'm very pleased to announce the release of our new Documentation Portal. Key features: * Responsive * Modern design * Theme support: Light, Dark, High contrast * Removed Python dependency Acknowledgment: * Alexander Leidinger <netchild (at) FreeBSD.org> * Baptiste Daroussin <bapt (at) FreeBSD.org> * Benedict Reuschling <bcr (at) freebsd.org> * Daniel Ebdrup Jensen <debdrup (at) FreeBSD.org> * Danilo G. Baio <dbaio (at) FreeBSD.org> * Dave Cottlehuber <dch (at) FreeBSD.org> * Ed Maste <emaste (at) FreeBSD.org> * Fernando Apesteguía <fernape (at) FreeBSD.org> * Pedro Giffuni <pfg (at) FreeBSD.org> * Joseph Mingrone <jrm (at) ftfl.ca> * Rocky Hotas <rockyhotas (at) firemail.cc> * Pau Amma <pauamma (at) gundo.com> * The FreeBSD Foundation Approved by: core, doceng
2021-12-11 09:57:33 +00:00
@(echo ${dep} not found, please run 'pkg install docproj'; exit 1)
documentation/Makefile: add requirements target Add the requirements target in order to prompt the user to install the needed dependencies to be able to run `make run` successfully. Reviewed by: ygy, debdrup, imp Approved by: ygy (doc) Differential Revision: https://reviews.freebsd.org/D30161
2021-05-07 14:02:37 +00:00
.endif
.endfor
Migrate doc to Hugo/AsciiDoctor I'm very pleased to announce the release of our new website and documentation using the new toolchain with Hugo and AsciiDoctor. To get more information about the new toolchain please read the FreeBSD Documentation Project Primer[1], Hugo docs[2] and AsciiDoctor docs[3]. Acknowledgment: Benedict Reuschling <bcr@> Glen Barber <gjb@> Hiroki Sato <hrs@> Li-Wen Hsu <lwhsu@> Sean Chittenden <seanc@> The FreeBSD Foundation [1] https://docs.FreeBSD.org/en/books/fdp-primer/ [2] https://gohugo.io/documentation/ [3] https://docs.asciidoctor.org/home/ Approved by: doceng, core
2021-01-25 23:31:29 +00:00
documentation: Remove asciidoctor-pdf from default requirements With the current requirements, if textproc/docproj is built with PDF option disabled, you can't build the documentation. This fixes that, and now asciidoctor-pdf will be checked only when building PDF. Reported by: jhb
2021-10-09 21:13:16 +00:00
requirements-pdf:
Update build instructions for macOS Approved by: carlavilla@ Reviewed by: Jose Luis Duran <jlduran_gmail.com> Differential Revision: https://reviews.freebsd.org/D37143
2022-11-02 21:40:13 +00:00
.if !exists(${ASCIIDOCTORPDF_CMD})
@(echo ${ASCIIDOCTOR_CMD} not found, please install rubygem-asciidoctor-pdf; exit 1)
documentation: Remove asciidoctor-pdf from default requirements With the current requirements, if textproc/docproj is built with PDF option disabled, you can't build the documentation. This fixes that, and now asciidoctor-pdf will be checked only when building PDF. Reported by: jhb
2021-10-09 21:13:16 +00:00
.endif
documentation: Add experimental support for EPUB output
2021-11-06 13:53:31 +00:00
requirements-epub:
Update build instructions for macOS Approved by: carlavilla@ Reviewed by: Jose Luis Duran <jlduran_gmail.com> Differential Revision: https://reviews.freebsd.org/D37143
2022-11-02 21:40:13 +00:00
.if !exists(${ASCIIDOCTOREPUB3_CMD})
@(echo ${ASCIIDOCTOREPUB3_CMD} not found, please install rubygem-asciidoctor-epub3; exit 1)
documentation: Add experimental support for EPUB output
2021-11-06 13:53:31 +00:00
.endif
build: slap fake targets with .PHONY This instructs make(1) to consider them always out of date, and prevents foot-shooting if a directory entry with the same name comes into existence. Reviewed-by: gjb, hrs Differential-Revision: https://reviews.freebsd.org/D28383
2021-01-27 16:09:02 +00:00
starting-message: .PHONY
Migrate doc to Hugo/AsciiDoctor I'm very pleased to announce the release of our new website and documentation using the new toolchain with Hugo and AsciiDoctor. To get more information about the new toolchain please read the FreeBSD Documentation Project Primer[1], Hugo docs[2] and AsciiDoctor docs[3]. Acknowledgment: Benedict Reuschling <bcr@> Glen Barber <gjb@> Hiroki Sato <hrs@> Li-Wen Hsu <lwhsu@> Sean Chittenden <seanc@> The FreeBSD Foundation [1] https://docs.FreeBSD.org/en/books/fdp-primer/ [2] https://gohugo.io/documentation/ [3] https://docs.asciidoctor.org/home/ Approved by: doceng, core
2021-01-25 23:31:29 +00:00
@echo ---------------------------------------------------------------
@echo Building the documentation
Makefile: If DOC_LANG is set, stop hugo from building other languages. The hugo driven targets currently build all the languages despite anything set in DOC_LANG or elsewhere. Have DOC_LANG drive HUGO_DISABLELANGUAGES in order to stop that. With the caveat that: hugo always has to build en as it's the default language, so add a warning if it's left out before adding it back in. Reviewed by: dbaio, ygy Differential Revision: https://reviews.freebsd.org/D30796
2021-06-30 11:39:33 +00:00
@echo included languages: ${LANGUAGES}
@echo excluded languages: ${SKIP_LANGS}
Migrate doc to Hugo/AsciiDoctor I'm very pleased to announce the release of our new website and documentation using the new toolchain with Hugo and AsciiDoctor. To get more information about the new toolchain please read the FreeBSD Documentation Project Primer[1], Hugo docs[2] and AsciiDoctor docs[3]. Acknowledgment: Benedict Reuschling <bcr@> Glen Barber <gjb@> Hiroki Sato <hrs@> Li-Wen Hsu <lwhsu@> Sean Chittenden <seanc@> The FreeBSD Foundation [1] https://docs.FreeBSD.org/en/books/fdp-primer/ [2] https://gohugo.io/documentation/ [3] https://docs.asciidoctor.org/home/ Approved by: doceng, core
2021-01-25 23:31:29 +00:00
@echo ---------------------------------------------------------------
documentation/Makefile: un-.PHONY generate-pgpkeys-txt target Approved by: blackend (mentor)
2021-06-01 12:33:14 +00:00
generate-pgpkeys-txt: static/pgpkeys/pgpkeys.txt
static/pgpkeys/pgpkeys.txt: static/pgpkeys/*key
Add new tool to generate the pgpkeys.txt file
2021-05-16 20:41:00 +00:00
${RUBY_CMD} ./tools/global-pgpkeys-creator.rb
Restore the generation of the TOCs in the Makefile Restore the generation of the TOCs in the Makefile when running make run
2021-02-13 21:40:00 +00:00
run-local: .PHONY
Makefile: If DOC_LANG is set, stop hugo from building other languages. The hugo driven targets currently build all the languages despite anything set in DOC_LANG or elsewhere. Have DOC_LANG drive HUGO_DISABLELANGUAGES in order to stop that. With the caveat that: hugo always has to build en as it's the default language, so add a warning if it's left out before adding it back in. Reviewed by: dbaio, ygy Differential Revision: https://reviews.freebsd.org/D30796
2021-06-30 11:39:33 +00:00
HUGO_DISABLELANGUAGES="${SKIP_LANGS}" ${HUGO_CMD} server \
${HUGO_ARGS} -D $(BIND:D--bind=$(BIND)) --baseURL="http://$(.HOST):1313"
Migrate doc to Hugo/AsciiDoctor I'm very pleased to announce the release of our new website and documentation using the new toolchain with Hugo and AsciiDoctor. To get more information about the new toolchain please read the FreeBSD Documentation Project Primer[1], Hugo docs[2] and AsciiDoctor docs[3]. Acknowledgment: Benedict Reuschling <bcr@> Glen Barber <gjb@> Hiroki Sato <hrs@> Li-Wen Hsu <lwhsu@> Sean Chittenden <seanc@> The FreeBSD Foundation [1] https://docs.FreeBSD.org/en/books/fdp-primer/ [2] https://gohugo.io/documentation/ [3] https://docs.asciidoctor.org/home/ Approved by: doceng, core
2021-01-25 23:31:29 +00:00
build: slap fake targets with .PHONY This instructs make(1) to consider them always out of date, and prevents foot-shooting if a directory entry with the same name comes into existence. Reviewed-by: gjb, hrs Differential-Revision: https://reviews.freebsd.org/D28383
2021-01-27 16:09:02 +00:00
build: .PHONY
Makefile: If DOC_LANG is set, stop hugo from building other languages. The hugo driven targets currently build all the languages despite anything set in DOC_LANG or elsewhere. Have DOC_LANG drive HUGO_DISABLELANGUAGES in order to stop that. With the caveat that: hugo always has to build en as it's the default language, so add a warning if it's left out before adding it back in. Reviewed by: dbaio, ygy Differential Revision: https://reviews.freebsd.org/D30796
2021-06-30 11:39:33 +00:00
HUGO_DISABLELANGUAGES="${SKIP_LANGS}" ${HUGO_CMD} ${HUGO_ARGS}
documentation/Makefile: Add PDF targets. Addition of various PDF targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en,fr" pdf-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. Reviewed by: ceri, gjb, dbaio Differential Revision: <https://reviews.freebsd.org/D30331>
2021-05-31 16:16:55 +00:00
Build offline documentation using Hugo and other improvements * 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
2021-11-03 16:39:08 +00:00
build-offline: .PHONY
HUGO_DISABLELANGUAGES="${SKIP_LANGS}" ${HUGO_CMD} ${HUGO_OFFLINE_ARGS}
Add a "clean" target. Reviewed by: ygy Differential Revision: https://reviews.freebsd.org/D30925
2021-06-29 08:57:30 +00:00
pgp-clean: .PHONY
rm -f static/pgpkeys/pgpkeys.txt
hugo-clean: .PHONY
rm -rf resources public
documentation/Makefile: Add PDF targets. Addition of various PDF targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en,fr" pdf-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. Reviewed by: ceri, gjb, dbaio Differential Revision: <https://reviews.freebsd.org/D30331>
2021-05-31 16:16:55 +00:00
#
# PDF targets
documentation/Makefile: use all languages by default Previously we only added languages with content in books/ to the LANGUAGES variable because they would cause the build to fail, and this meant that they did not get PDFs built either. It also meant they could not be included in DOC_LANG as this then break the build. Add a new variable, ARTICLEONLY_LANGS, to identify them and, with the safety of the new logic in the tools/book-toc*py scripts to warn if we miss one, build all of the content by default under the PDF target. This also makes DOC_LANG safe to use even if there isn't a book in that language.
2021-06-16 16:42:28 +00:00
# Use DOC_LANG to choose the language, e.g., make DOC_LANG="en fr" pdf-books
documentation/Makefile: Add PDF targets. Addition of various PDF targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en,fr" pdf-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. Reviewed by: ceri, gjb, dbaio Differential Revision: <https://reviews.freebsd.org/D30331>
2021-05-31 16:16:55 +00:00
#
pdf: pdf-articles pdf-books
New Documentation Portal I'm very pleased to announce the release of our new Documentation Portal. Key features: * Responsive * Modern design * Theme support: Light, Dark, High contrast * Removed Python dependency Acknowledgment: * Alexander Leidinger <netchild (at) FreeBSD.org> * Baptiste Daroussin <bapt (at) FreeBSD.org> * Benedict Reuschling <bcr (at) freebsd.org> * Daniel Ebdrup Jensen <debdrup (at) FreeBSD.org> * Danilo G. Baio <dbaio (at) FreeBSD.org> * Dave Cottlehuber <dch (at) FreeBSD.org> * Ed Maste <emaste (at) FreeBSD.org> * Fernando Apesteguía <fernape (at) FreeBSD.org> * Pedro Giffuni <pfg (at) FreeBSD.org> * Joseph Mingrone <jrm (at) ftfl.ca> * Rocky Hotas <rockyhotas (at) firemail.cc> * Pau Amma <pauamma (at) gundo.com> * The FreeBSD Foundation Approved by: core, doceng
2021-12-11 09:57:33 +00:00
pdf-books: requirements-pdf
documentation/Makefile: Add HTML targets for offline use Addition of various HTML targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en fr" html-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. The produced files do not include some metadatas, they are intended for offline use. Reviewed by: ceri Differential Revision: https://reviews.freebsd.org/D30718
2021-07-14 10:28:49 +00:00
.for _lang in ${BOOK_LANGS}
Build offline documentation using Hugo and other improvements * 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
2021-11-03 16:39:08 +00:00
./tools/asciidoctor.sh books ${_lang} pdf
documentation/Makefile: Add PDF targets. Addition of various PDF targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en,fr" pdf-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. Reviewed by: ceri, gjb, dbaio Differential Revision: <https://reviews.freebsd.org/D30331>
2021-05-31 16:16:55 +00:00
.endfor
Build offline documentation using Hugo and other improvements * 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
2021-11-03 16:39:08 +00:00
pdf-articles: requirements-pdf
documentation/Makefile: Add HTML targets for offline use Addition of various HTML targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en fr" html-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. The produced files do not include some metadatas, they are intended for offline use. Reviewed by: ceri Differential Revision: https://reviews.freebsd.org/D30718
2021-07-14 10:28:49 +00:00
.for _lang in ${ARTICLE_LANGS}
Build offline documentation using Hugo and other improvements * 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
2021-11-03 16:39:08 +00:00
./tools/asciidoctor.sh articles ${_lang} pdf
documentation/Makefile: Add PDF targets. Addition of various PDF targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en,fr" pdf-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. Reviewed by: ceri, gjb, dbaio Differential Revision: <https://reviews.freebsd.org/D30331>
2021-05-31 16:16:55 +00:00
.endfor
pdf-clean: pdf-articles-clean pdf-books-clean
Build offline documentation using Hugo and other improvements * 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
2021-11-03 16:39:08 +00:00
pdf-books-clean:
documentation/Makefile: Add HTML targets for offline use Addition of various HTML targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en fr" html-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. The produced files do not include some metadatas, they are intended for offline use. Reviewed by: ceri Differential Revision: https://reviews.freebsd.org/D30718
2021-07-14 10:28:49 +00:00
.for _lang in ${BOOK_LANGS}
documentation/Makefile: Add PDF targets. Addition of various PDF targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en,fr" pdf-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. Reviewed by: ceri, gjb, dbaio Differential Revision: <https://reviews.freebsd.org/D30331>
2021-05-31 16:16:55 +00:00
rm -fr ${.CURDIR}/public/${_lang}/books
documentation/Makefile: Add HTML targets for offline use Addition of various HTML targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en fr" html-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. The produced files do not include some metadatas, they are intended for offline use. Reviewed by: ceri Differential Revision: https://reviews.freebsd.org/D30718
2021-07-14 10:28:49 +00:00
-rmdir ${.CURDIR}/public/${_lang}
.endfor
-rmdir ${.CURDIR}/public/
Build offline documentation using Hugo and other improvements * 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
2021-11-03 16:39:08 +00:00
pdf-articles-clean:
documentation/Makefile: Add HTML targets for offline use Addition of various HTML targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en fr" html-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. The produced files do not include some metadatas, they are intended for offline use. Reviewed by: ceri Differential Revision: https://reviews.freebsd.org/D30718
2021-07-14 10:28:49 +00:00
.for _lang in ${ARTICLE_LANGS}
Build offline documentation using Hugo and other improvements * 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
2021-11-03 16:39:08 +00:00
rm -fr ${.CURDIR}/public/${_lang}/articles
.if !exists(${.CURDIR}/public/${_lang}/books)
rm -fr ${.CURDIR}/public/${_lang}
documentation/Makefile: Add HTML targets for offline use Addition of various HTML targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en fr" html-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. The produced files do not include some metadatas, they are intended for offline use. Reviewed by: ceri Differential Revision: https://reviews.freebsd.org/D30718
2021-07-14 10:28:49 +00:00
.endif
.endfor
Build offline documentation using Hugo and other improvements * 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
2021-11-03 16:39:08 +00:00
-rmdir ${.CURDIR}/public
documentation/Makefile: Add HTML targets for offline use Addition of various HTML targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en fr" html-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. The produced files do not include some metadatas, they are intended for offline use. Reviewed by: ceri Differential Revision: https://reviews.freebsd.org/D30718
2021-07-14 10:28:49 +00:00
Build offline documentation using Hugo and other improvements * 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
2021-11-03 16:39:08 +00:00
#
# HTML targets
#
New Documentation Portal I'm very pleased to announce the release of our new Documentation Portal. Key features: * Responsive * Modern design * Theme support: Light, Dark, High contrast * Removed Python dependency Acknowledgment: * Alexander Leidinger <netchild (at) FreeBSD.org> * Baptiste Daroussin <bapt (at) FreeBSD.org> * Benedict Reuschling <bcr (at) freebsd.org> * Daniel Ebdrup Jensen <debdrup (at) FreeBSD.org> * Danilo G. Baio <dbaio (at) FreeBSD.org> * Dave Cottlehuber <dch (at) FreeBSD.org> * Ed Maste <emaste (at) FreeBSD.org> * Fernando Apesteguía <fernape (at) FreeBSD.org> * Pedro Giffuni <pfg (at) FreeBSD.org> * Joseph Mingrone <jrm (at) ftfl.ca> * Rocky Hotas <rockyhotas (at) firemail.cc> * Pau Amma <pauamma (at) gundo.com> * The FreeBSD Foundation Approved by: core, doceng
2021-12-11 09:57:33 +00:00
html: build-offline html-clean-global html-clean-articles html-clean-books html-archive html-archive-clean-files
documentation/Makefile: Add HTML targets for offline use Addition of various HTML targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en fr" html-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. The produced files do not include some metadatas, they are intended for offline use. Reviewed by: ceri Differential Revision: https://reviews.freebsd.org/D30718
2021-07-14 10:28:49 +00:00
Build offline documentation using Hugo and other improvements * 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
2021-11-03 16:39:08 +00:00
html-clean: hugo-clean
documentation/Makefile: Add HTML targets for offline use Addition of various HTML targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en fr" html-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. The produced files do not include some metadatas, they are intended for offline use. Reviewed by: ceri Differential Revision: https://reviews.freebsd.org/D30718
2021-07-14 10:28:49 +00:00
Build offline documentation using Hugo and other improvements * 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
2021-11-03 16:39:08 +00:00
html-clean-global:
rm -fr ${.CURDIR}/public/index.html
rm -rf pgpkeys js
documentation/Makefile: Add HTML targets for offline use Addition of various HTML targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en fr" html-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. The produced files do not include some metadatas, they are intended for offline use. Reviewed by: ceri Differential Revision: https://reviews.freebsd.org/D30718
2021-07-14 10:28:49 +00:00
Build offline documentation using Hugo and other improvements * 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
2021-11-03 16:39:08 +00:00
html-clean-articles:
documentation/Makefile: Add HTML targets for offline use Addition of various HTML targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en fr" html-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. The produced files do not include some metadatas, they are intended for offline use. Reviewed by: ceri Differential Revision: https://reviews.freebsd.org/D30718
2021-07-14 10:28:49 +00:00
.for _lang in ${ARTICLE_LANGS}
Build offline documentation using Hugo and other improvements * 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
2021-11-03 16:39:08 +00:00
rm -fr ${.CURDIR}/public/${_lang}/index.html
rm -fr ${.CURDIR}/public/${_lang}/articles/index.html
documentation/Makefile: Add PDF targets. Addition of various PDF targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en,fr" pdf-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. Reviewed by: ceri, gjb, dbaio Differential Revision: <https://reviews.freebsd.org/D30331>
2021-05-31 16:16:55 +00:00
.endfor
Build offline documentation using Hugo and other improvements * 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
2021-11-03 16:39:08 +00:00
html-clean-books:
.for _lang in ${BOOK_LANGS}
rm -fr ${.CURDIR}/public/${_lang}/books/index.html
documentation/Makefile: Add PDF targets. Addition of various PDF targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en,fr" pdf-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. Reviewed by: ceri, gjb, dbaio Differential Revision: <https://reviews.freebsd.org/D30331>
2021-05-31 16:16:55 +00:00
.endfor
documentation: Add an option to archive/compress HTML offline files Reviewed by: carlavilla Differential Revision: https://reviews.freebsd.org/D32867
2021-11-04 23:07:26 +00:00
html-archive:
.if defined(DOC_HTML_ARCHIVE)
.for _lang in ${ARTICLE_LANGS}
./tools/asciidoctor.sh articles ${_lang} archive
.endfor
.for _lang in ${BOOK_LANGS}
./tools/asciidoctor.sh books ${_lang} archive
.endfor
.endif
html-archive-clean-files:
.if defined(DOC_HTML_ARCHIVE)
find ${.CURDIR}/public/ ! -name '*.pdf' ! -name '*.tar.gz' -type f -delete
find ${.CURDIR}/public/ -type d -empty -delete
.endif
documentation: Add experimental support for EPUB output
2021-11-06 13:53:31 +00:00
#
# EPUB targets
documentation/Makefile: Fix comment
2021-11-06 14:00:05 +00:00
# Use DOC_LANG to choose the language, e.g., make DOC_LANG="en fr" epub-books
documentation: Add experimental support for EPUB output
2021-11-06 13:53:31 +00:00
#
epub: epub-articles epub-books
New Documentation Portal I'm very pleased to announce the release of our new Documentation Portal. Key features: * Responsive * Modern design * Theme support: Light, Dark, High contrast * Removed Python dependency Acknowledgment: * Alexander Leidinger <netchild (at) FreeBSD.org> * Baptiste Daroussin <bapt (at) FreeBSD.org> * Benedict Reuschling <bcr (at) freebsd.org> * Daniel Ebdrup Jensen <debdrup (at) FreeBSD.org> * Danilo G. Baio <dbaio (at) FreeBSD.org> * Dave Cottlehuber <dch (at) FreeBSD.org> * Ed Maste <emaste (at) FreeBSD.org> * Fernando Apesteguía <fernape (at) FreeBSD.org> * Pedro Giffuni <pfg (at) FreeBSD.org> * Joseph Mingrone <jrm (at) ftfl.ca> * Rocky Hotas <rockyhotas (at) firemail.cc> * Pau Amma <pauamma (at) gundo.com> * The FreeBSD Foundation Approved by: core, doceng
2021-12-11 09:57:33 +00:00
epub-books: requirements-epub
documentation: Add experimental support for EPUB output
2021-11-06 13:53:31 +00:00
@echo ---------------------------------------------------------------
@echo !!! EPUB output is experimental !!!
@echo
@echo Asciidoctor EPUB3 is currently alpha software. Use accordingly. Although the
@echo bulk of AsciiDoc content is converted, there’s still work needed to fill in
@echo gaps where conversion is incomplete or unstyled.
@echo https://docs.asciidoctor.org/epub3-converter/latest/#project-status
@echo ---------------------------------------------------------------
.for _lang in ${BOOK_LANGS}
./tools/asciidoctor.sh books ${_lang} epub
.endfor
epub-articles: requirements-epub
@echo ---------------------------------------------------------------
@echo !!! EPUB output is experimental !!!
@echo
@echo Asciidoctor EPUB3 is currently alpha software. Use accordingly. Although the
@echo bulk of AsciiDoc content is converted, there’s still work needed to fill in
@echo gaps where conversion is incomplete or unstyled.
@echo https://docs.asciidoctor.org/epub3-converter/latest/#project-status
@echo ---------------------------------------------------------------
.for _lang in ${ARTICLE_LANGS}
./tools/asciidoctor.sh articles ${_lang} epub
.endfor
epub-clean: epub-articles-clean epub-books-clean
epub-books-clean:
.for _lang in ${BOOK_LANGS}
rm -fr ${.CURDIR}/public/${_lang}/books
-rmdir ${.CURDIR}/public/${_lang}
.endfor
-rmdir ${.CURDIR}/public/
epub-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