This repository holds the sources of Firebird user documentation. You can find the documentation in HTML and PDF format on the Firebird site under Documentation.
After checking out the firebird-documentation repository, and if your Java environment is set up correctly (Java 17 or higher is required), open a command window and go to the directory containing the firebird-documentation repository. Then give one of these commands:
./gradlew [ Unix ]
.\gradlew [ Windows ]
to get an overview of compilable targets.
If that worked, try e.g.:
./gradlew asciidocHtml [ Unix ]
.\gradlew asciidocHtml [ Windows ]
to build the HTML version of the docs.
(Note: the HTML pages will wind up in build/docs/asciidoc/html/en/firebirddocs)
To build a specific document, or a document from another set, or another language, you can specify:
./gradlew asciidocHtml --docId=gbak
./gradlew asciidocPdf --baseName=refdocs --docId=fblangref25
./gradlew asciidocHtml --language=de
To get more information on a task, use
./gradlew help --task=asciidocHtml [ Unix ]
.\gradlew help --task=asciidocHtml [ Windows ]
The docbookHtml and docbookPdf tasks are available to build documentation
that has not been migrated to AsciiDoc. However, if you feel the need to build
those documents, it might be an indication they need to be migrated. Please
ask for guidance or help on the firebird-devel list.
If you have any questions, first get the Docbuilding Howto at:
https://firebirdsql.org/en/reference-manuals/
If your question isn't answered there, post a message to the Firebird Development list. You can use this page to subscribe: