git: 079fda540d - main - fdp-primer/doc-build: Update pdf instructions
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Sun, 09 Jan 2022 11:37:50 UTC
The branch main has been updated by dbaio: URL: https://cgit.FreeBSD.org/doc/commit/?id=079fda540d30e1830239bede5fcb8a2816993850 commit 079fda540d30e1830239bede5fcb8a2816993850 Author: Danilo G. Baio <dbaio@FreeBSD.org> AuthorDate: 2022-01-09 02:29:08 +0000 Commit: Danilo G. Baio <dbaio@FreeBSD.org> CommitDate: 2022-01-09 11:36:30 +0000 fdp-primer/doc-build: Update pdf instructions Now there are specific targets to build pdf documents. It's not needed to use asciidoctor-pdf directly. --- .../en/books/fdp-primer/doc-build/_index.adoc | 59 ++++++++++++++++------ 1 file changed, 44 insertions(+), 15 deletions(-) diff --git a/documentation/content/en/books/fdp-primer/doc-build/_index.adoc b/documentation/content/en/books/fdp-primer/doc-build/_index.adoc index 19c2b20063..f240133e53 100644 --- a/documentation/content/en/books/fdp-primer/doc-build/_index.adoc +++ b/documentation/content/en/books/fdp-primer/doc-build/_index.adoc @@ -154,31 +154,60 @@ A `hostname` can also be set as base url to Hugo’s internal webserver: [[doc-build-rendering-pdf]] === Rendering to pdf -To generate a document in `pdf` format use this command. -In this example the English Handbook will be used. -In order to export the document correctly all the extensions should be passed using the `-r` argument. +To render the documentation to `pdf`, use one of the following examples. [[document-pdf-example]] -.Build a document in pdf +.Build all documents in pdf [example] ==== [source,shell] .... % cd ~/doc/documentation -% asciidoctor-pdf \ - -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=./themes/default-pdf-theme.yml \ - -o /tmp/handbook.pdf \ - content/en/books/handbook/book.adoc +% make pdf .... ==== +[[document-pdf-articles-example]] +.Build all articles in pdf +[example] +==== +[source,shell] +.... +% cd ~/doc/documentation +% make pdf-articles +.... +==== + +[[document-pdf-books-example]] +.Build all books in pdf +[example] +==== +[source,shell] +.... +% cd ~/doc/documentation +% make pdf-books +.... +==== + +[[document-pdf-language-example]] +.Build documents in pdf for specific languages +[example] +==== +[source,shell] +.... +% cd ~/doc/documentation +% make DOC_LANG="en" pdf +.... +This will build all English documents in pdf. + +[source,shell] +.... +% cd ~/doc/documentation +% make DOC_LANG="en fr" pdf-books +.... +This will build all English and French books in pdf. +==== + [[doc-build-toolset]] == The FreeBSD Documentation Build Toolset