lazarus/docs/html
2021-10-30 11:56:47 +02:00
..
.gitignore docs: gitignore 2021-10-30 10:39:34 +02:00
build_chm.bat Revert "Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500." 2021-10-29 17:28:13 +01:00
build_chm.sh Revert "Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500." 2021-10-29 17:28:13 +01:00
build_html.bat Revert "Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500." 2021-10-29 17:28:13 +01:00
build_html.sh docs: readme 2021-10-30 11:56:47 +02:00
build_lcl_docs.lpi Revert "Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500." 2021-10-29 17:28:13 +01:00
build_lcl_docs.lpr Revert "Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500." 2021-10-29 17:28:13 +01:00
fpdoc.css Revert "Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500." 2021-10-29 17:28:13 +01:00
localfclfooter.xml
locallclfooter.xml Revert "Docs: Modifies build_lcl_docs and scripts.Address an issue in #28500." 2021-10-29 17:28:13 +01:00
localrtlfooter.xml
Makefile
README.txt docs: readme 2021-10-30 11:56:47 +02:00

HTML documentation of Lazarus
=============================

This directory contains the tools to create the HTML and CHM documentation for
Lazarus. The documentation is stored in fpdoc format in the docs/xml/ directory.

For UNIXes:

The script build_html.sh will automatically create the whole HTML
documentation.
Build build_lcl_docs.lpi
../../lazbuild build_lcl_docs.lpi

./build_lcl_docs --fpdoc /path/to/fpc/trunk/utils/fpdoc/fpdoc --fpcdocs=../chm --outfmt chm --footer locallclfooter.xml

Note: It is recommened to use the fpdoc from fpc trunk. If you are unlucky and got a buggy revision, you can try with the released fpdoc.

For Windows:

Build the project build_lcl_docs.lpi, fix the PATH in the build_html.bat batch
script to your local installation and then run the script, or run
build_lcl_docs.exe directly.