Compiled html docs

What would you like to see in Freeciv? Do you have a good idea what should be improved or how?
Post Reply
Elefant
Veteran
Posts: 134
Joined: Sat May 28, 2022 3:55 am

Compiled html docs

Post by Elefant »

Basically, I want to be able to download an up to date compiled html webpage with the doxygen files and a Lua api reference. I don't have a great internet connection, and so to use the online version is a bit of a hassle. Really, though, a zip file with the doxygen files would be fine, too.
cazfi
Elite
Posts: 2534
Joined: Tue Jan 29, 2013 6:54 pm

Re: Compiled html docs

Post by cazfi »

Elefant wrote: Thu Sep 22, 2022 2:57 pm Really, though, a zip file with the doxygen files would be fine, too.
I'll look at it before next weekend's doxygen refresh (with the disclaimer that during last two weeks I've had a bit too many doctor's appointments for my taste - but there should be nothing acute now). Ticket against "CI" component might help me to remember ;-)
cazfi
Elite
Posts: 2534
Joined: Tue Jan 29, 2013 6:54 pm

Re: Compiled html docs

Post by cazfi »

I did a simple change to the weekly script so that it does .7z archive of the doxygen documentation, and publish that alongside the online version. (We'll see on Monday morning if that worked as expected)

Currently that packages just the html documentation generated for the online version. Should we generate that documentation in some other (doxygen supported) format?
Elefant
Veteran
Posts: 134
Joined: Sat May 28, 2022 3:55 am

Re: Compiled html docs

Post by Elefant »

The online version is good. That should be good. The only problem I have had is that it needs a good internet connection.
cazfi
Elite
Posts: 2534
Joined: Tue Jan 29, 2013 6:54 pm

Re: Compiled html docs

Post by cazfi »

cazfi wrote: Sat Sep 24, 2022 10:53 am (We'll see on Monday morning if that worked as expected)
Files seem to be there. https://files.freeciv.org/nightly/weekly/
Elefant
Veteran
Posts: 134
Joined: Sat May 28, 2022 3:55 am

Re: Compiled html docs

Post by Elefant »

Great! They seem to work, but when I extracted the .7z, it had some files with the same name, although different capitalization, and wanted me to rename them.
cazfi
Elite
Posts: 2534
Joined: Tue Jan 29, 2013 6:54 pm

Re: Compiled html docs

Post by cazfi »

Elefant wrote: Mon Sep 26, 2022 3:49 pm Great! They seem to work, but when I extracted the .7z, it had some files with the same name, although different capitalization, and wanted me to rename them.
Doxygen seems to have a setting related to this, but I suspect we can't use that
# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
# able to match the capabilities of the underlying filesystem. In case the
# filesystem is case sensitive (i.e. it supports files in the same directory
# whose names only differ in casing), the option must be set to YES to properly
# deal with such files in case they appear in the input. For filesystems that
# are not case sensitive the option should be set to NO to properly deal with
# output files written for symbols that only differ in casing, such as for two
# classes, one named CLASS and the other named Class, and to also support
# references to files without having to specify the exact matching casing. On
# Windows (including Cygwin) and MacOS, users should typically set this option
# to NO, whereas on Linux or other Unix flavors it should typically be set to
# YES.
# The default value is: system dependent.

CASE_SENSE_NAMES = YES
As there seems to be just one setting, and not two separate settings for input and output, I don't think we can set it to NO as that would break generating the documentation on linux side.
cazfi
Elite
Posts: 2534
Joined: Tue Jan 29, 2013 6:54 pm

Re: Compiled html docs

Post by cazfi »

Elefant wrote: Mon Sep 26, 2022 3:49 pm Great! They seem to work, but when I extracted the .7z, it had some files with the same name, although different capitalization, and wanted me to rename them.
Now https://osdn.net/projects/freeciv/ticket/45736
cazfi
Elite
Posts: 2534
Joined: Tue Jan 29, 2013 6:54 pm

Re: Compiled html docs

Post by cazfi »

Pushed the patch from that one, hopefully it helps. Unfortunately missed the weekly documentation regeneration. I'll see if I can manually trigger extra build tonight.
Post Reply