From f4efaa4b66b69dbcc3057a65afbe473b0449a220 Mon Sep 17 00:00:00 2001 From: mattias Date: Sat, 30 Oct 2021 11:56:47 +0200 Subject: [PATCH] docs: readme (cherry picked from commit f8af491a06217fc280283176cc1c1fbf298cfd89) --- docs/html/README.txt | 2 ++ docs/html/build_html.sh | 4 +++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/html/README.txt b/docs/html/README.txt index c26885dac9..71f40eabc6 100644 --- a/docs/html/README.txt +++ b/docs/html/README.txt @@ -13,6 +13,8 @@ Build 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 diff --git a/docs/html/build_html.sh b/docs/html/build_html.sh index bd08285f01..384e4ae619 100755 --- a/docs/html/build_html.sh +++ b/docs/html/build_html.sh @@ -6,7 +6,9 @@ # Before running this file, first compile the project build_lcl_docs.lpi # # In order to link to RTL and FCL, place rtl.xct and fcl.xct in ../chm/ -# +# +# This uses the fpdoc in PATH. See README.txt +# ./build_lcl_docs --fpcdocs=../chm --outfmt html