Sign in Join

Live chat for Free Pascal, Lazarus, Delphi and every Pascal programmer.

Mailing lists / fpc-pascal / 2019-08

Documentation generation

5 messages · 5 people · –

Reply by email Subscribe to this list Your subscription

Read-only archive. Use j and k to move between messages.

Ryan Joseph

How are the FPC RTL documentations generated? I wanted to see if I could generate .docsets files from them also.

Regards,
Ryan Joseph

Reply by email

Michael Van Canneyt
to leledumbo
leledumbo wrote 6 lines
> How are the FPC RTL documentations generated? I wanted to see if I could generate .docsets files from them also. A starting point: https://wiki.freepascal.org/FPCDocs_Tutorial I believe that "write me" part is not far from calling make with certain options.

You simply call

make rtl.pdf

for the PDF version or

make rtl.chk

for the HTML version.

The README.DOCS file contains the following:
---
If you only want to generate the RTL and FCL reference documentation in HTML format, starting from the fpdoc XML descriptions, then the following 2 commands should be enough:

make rtl.chk
make fcl.chk

---

One wonders why these README files are created. No-one seems to read them anyway.

Michael.

Reply by email

Marco van de Voort
to Michael Van Canneyt

Op 2019-08-18 om 11:43 schreef Michael Van Canneyt:

Show quoted text 19 lines
On Sat, 17 Aug 2019, leledumbo via fpc-pascal wrote: >> How are the FPC RTL documentations generated? I wanted to see if I >> could > generate .docsets files from them also. > > A starting point: https://wiki.freepascal.org/FPCDocs_Tutorial > I believe that "write me" part is not far from calling make with certain > options. You simply call make rtl.pdf for the PDF version or make rtl.chk

and the fixdocs.sh shell script for the CHM version.

Reply by email

Graeme Geldenhuys
to Michael Van Canneyt: You simply call make rtl.pdf for the PDF version or make rtl.chk for the HTML version.…
Michael Van Canneyt wrote
One wonders why these README files are created. No-one seems to read them anyway.

Yeah, I've been wondering that same thing for years. Maybe we should create a README.1st file. :-P

Regards,
Graeme

fpGUI Toolkit - a cross-platform GUI toolkit using Free Pascal http://fpgui.sourceforge.net/ My public PGP key: http://tinyurl.com/graeme-pgp

Reply by email