Repository files navigation

After checking out the firebird-documentation repository, and if yourJava environment is set up correctly, open a command window and go tothe directory containing the firebird-documentation repository. Thengive 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 anotherlanguage, you can specify:

gradlew asciidocHtml --docId=gbakgradlew asciidocPdf --baseName=refdocs --docId=fblangref25gradlew asciidocHtml --language=de

To get more information on a task, use

./gradlew help --task=asciidocHtml [ Unix    ]gradlew help --task=asciidocHtml   [ Windows ]

Warning: if you build the asciidocPdf target, you might get some errormessages. Don't let that discourage you. Just look at the lastoutput lines: if it says BUILD SUCCESSFUL there, everything's fine.

ThedocbookHtml anddocbookPdf tasks are available to build documentationthat has not been migrated to AsciiDoc. However, if you feel the need to buildthose documents, it might be an indication they need to be migrated. Pleaseask for guidance or help on thefirebird-devel list.

If you have any questions,first get the Docbuilding Howto at:

https://www.firebirdsql.org/en/reference-manuals/

If your question isn't answered there, post a message to the FirebirdDevelopment list. You can use this page to subscribe:

https://groups.google.com/g/firebird-devel