Sign in Join

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

Mailing lists / lazarus / 2008-04

Building the Lazarus docs

14 messages · 4 people · –

Reply by email Subscribe to this list Your subscription

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

Felipe Monteiro de Carvalho

Hello,

How can I build all lazarus docs?

thanks,

Felipe Monteiro de Carvalho
Felipe Monteiro de Carvalho
to Graeme Geldenhuys

So I use update_lcl_html.sh ?

A bit unintuitive, not? I have never built the docs, so I have nothing to be updated. I'd expect the script to be named build_lcl_html.sh, and preferably directly in the docs dir instead of the html dir to be easier to find.

Felipe Monteiro de Carvalho
Graeme Geldenhuys
to Felipe Monteiro de Carvalho
Felipe Monteiro de Carvalho wrote 7 lines
So I use update_lcl_html.sh ? A bit unintuitive, not? I have never built the docs, so I have nothing to be updated. I'd expect the script to be named build_lcl_html.sh, and preferably directly in the docs dir instead of the html dir to be easier to find.

:-) Yeah it could use some improving! I had to view the script first to see what it does. I haven't built the Lazarus docs in months. And now that the IDE can read the .xml files directly (via tooltips in the editor), I don't see the need, other to publish it to the web.

Regards,
- Graeme -

_______________________________________________________ fpGUI - a cross-platform GUI toolkit using Free Pascal http://opensoft.homeip.net/fpgui/

Vincent Snijders
to Mattias Gärtner
Mattias G?rtner wrote 13 lines
Zitat von Felipe Monteiro de Carvalho : > So I use update_lcl_html.sh ? > > A bit unintuitive, not? I have never built the docs, so I have nothing > to be updated. I'd expect the script to be named build_lcl_html.sh, > and preferably directly in the docs dir instead of the html dir to be > easier to find. Historical reasons. If you want to rename them, ask Vincent. Maybe he is using them for the snapshots.

Feel free to rename them, I will update my script.

Vincent

Felipe Monteiro de Carvalho
to Vincent Snijders
Vincent Snijders wrote
Feel free to rename them, I will update my script.

And what about moving them to docs/ instead of docs/html?

What do you think about this idea?

thanks,

Felipe Monteiro de Carvalho
Vincent Snijders
to Felipe Monteiro de Carvalho
Felipe Monteiro de Carvalho wrote 7 lines
On Thu, Apr 24, 2008 at 3:27 PM, Vincent Snijders wrote: > Feel free to rename them, I will update my script. And what about moving them to docs/ instead of docs/html? What do you think about this idea?

I am not sure, it is for generating the html docs after all.

Vincent

Felipe Monteiro de Carvalho
to Felipe Monteiro de Carvalho

Could we please, please, please have periodical automatic updates to the html lcl docs =P Preferrably daily, if impossible, then weekly or another suitable periode.

I remember vaguely that they weren't done because it takes hours to build the docs.

Here they were created in less then 10 minutes with fpc 2.2.0.

In something else, my batch script generates a bit ugly docs. Plain html without colors, or anything ... how can I make it look better?

thanks,

Felipe Monteiro de Carvalho
Graeme Geldenhuys
to Felipe Monteiro de Carvalho
Felipe Monteiro de Carvalho wrote
In something else, my batch script generates a bit ugly docs. Plain html without colors, or anything ... how can I make it look better?

This is a old problem I complained about before, but nobody bothered. By default the fpdoc.css file is not auto generated (preferred) or included. Copy the one from the FPC docs website into your html directory and things should look much better. ;)

Regards,
- Graeme -

_______________________________________________________ fpGUI - a cross-platform GUI toolkit using Free Pascal http://opensoft.homeip.net/fpgui/

Vincent Snijders
to Graeme Geldenhuys
Graeme Geldenhuys wrote 8 lines
Felipe Monteiro de Carvalho wrote: > In something else, my batch script generates a bit ugly docs. Plain > html without colors, or anything ... how can I make it look better? This is a old problem I complained about before, but nobody bothered. By default the fpdoc.css file is not auto generated (preferred) or included. Copy the one from the FPC docs website into your html directory and things should look much better. ;)

It is in svn:
http://svn.freepascal.org/svn/lazarus/trunk/docs/html/fpdoc.css

Vincent

Vincent Snijders
to Felipe Monteiro de Carvalho: Could we please, please, please have periodical automatic updates to the html lcl docs =P…
Felipe Monteiro de Carvalho wrote
Could we please, please, please have periodical automatic updates to the html lcl docs =P Preferrably daily, if impossible, then weekly or another suitable periode.

I don't know exactly what you mean, the docs on
http://lazarus-ccr.sourceforge.net/docs/ are updated daily for almost 3 years.

The daily snapshot at
ftp://ftp.hu.freepascal.org/pub/lazarus/fpc-lazarus-doc-html-20080424.tar.bz2 is refreshed daily since at least last December.

I remember vaguely that they weren't done because it takes hours to build the docs.

The reason it was not done, was that the docs hardly changed in the past. Since Chris started to work on it regularly, there are almost daily changes.

Here they were created in less then 10 minutes with fpc 2.2.0.

You have better hardware, here it takes about 25 minutes.

Vincent