What is the update frequency of the chm doc file?

Forum for discussion about the documentation project.
Tourist Trap
Posts: 2028
Joined: Jun 02, 2015 16:24

What is the update frequency of the chm doc file?

Postby Tourist Trap » Aug 04, 2016 19:35

Some revision of the compiler may take more time than others, and in the mean time the documentation may have been improved. Can we count on a rebuild of it those days? Has it already been done silently?

Thanks for the attention.
St_W
Posts: 765
Joined: Feb 11, 2009 14:24
Location: Austria
Contact:

Re: What is the update frequency of the chm doc file?

Postby St_W » Aug 04, 2016 21:55

If I can get the data without direct access to the SQL database (and the fbdoc tool seems to be able to do so according to its documentation) I could build a documentation on my Jenkins Server in addition to my nightly fbc builds.

I'll have a look into this over the weekend.

You can find the fbdoc tool here: https://github.com/freebasic/fbc/tree/master/doc/fbdoc
You can try to download & build the documentation with it yourself on your PC too.
dkl
Site Admin
Posts: 3130
Joined: Jul 28, 2005 14:45
Location: Germany

Re: What is the update frequency of the chm doc file?

Postby dkl » Aug 05, 2016 5:54

Check out this FB wiki page on how to update the documentation files in the fbc checkout by downloading from the wiki:
http://www.freebasic.net/wiki/wikka.php ... eases#DOCS

Then
cd doc/manual
make


I've only done it as part of compiler releases so far, but of course technically there's no problem doing it separately, as long as the file name will include something like a date instead of just the FB version number.
Tourist Trap
Posts: 2028
Joined: Jun 02, 2015 16:24

Re: What is the update frequency of the chm doc file?

Postby Tourist Trap » Aug 05, 2016 8:06

St_W wrote:I'll have a look into this over the weekend.

Thanks it would be nice of you.
dkl wrote:I've only done it as part of compiler releases so far, but of course technically there's no problem doing it separately, as long as the file name will include something like a date instead of just the FB version number.

The offline help is quite comfortable to use when you are used to those chm documents, so it would desserve it I think.
I'll also try to make this myself when I have enough time. It's also a possibility!
St_W
Posts: 765
Joined: Feb 11, 2009 14:24
Location: Austria
Contact:

Re: What is the update frequency of the chm doc file?

Postby St_W » Aug 08, 2016 1:24

It took some time until everything was working, but now I've added a build-job that fetches the latest documentation according to the steps on the wiki page dkl mentioned and then builds & uploads a CHM file. It's currently in an early stage and things might change, but currently my latest manual build can be found here (and is always overwritten by newer ones):
http://users.freebasic-portal.de/stw/bu ... manual.chm

Currently new builds aren't triggered automatically. I'd like to trigger build on RSS updates (http://freebasic.net/wiki/wikka.php?wak ... hanges.xml) in future and make it faster by fetching only the changed pages. As of now these are only ideas. If it's useful/wanted to have older documentation builds available (not only the latest one) I could structure them in a separate subdirectory like I'm already doing for fbc builds. Additional documentation-formats are also possible if needed, but currently not implemented.

As getting all the dependencies for the build caused some troubles, I've uploaded a package containing all the needed headers and (import+shared) libraries for win32: http://users.freebasic-portal.de/stw/fi ... dencies.7z
That should help to get the documentation build running on your own PC faster & easier.


btw: I think some of the tools in doc/fbchkdoc are broken (e.g. getindex -web) - at least my builds did not work as expected / described in the readme files.
Tourist Trap
Posts: 2028
Joined: Jun 02, 2015 16:24

Re: What is the update frequency of the chm doc file?

Postby Tourist Trap » Aug 08, 2016 8:23

St_W wrote:It took some time until everything was working, but now I've added a build-job that fetches the latest documentation according to the steps on the wiki page dkl mentioned and then builds & uploads a CHM file. It's currently in an early stage and things might change, but currently my latest manual build can be found here (and is always overwritten by newer ones):
http://users.freebasic-portal.de/stw/bu ... manual.chm

Hi St_W,

I've downloaded the file, it works perfectly (just as usual one has to unblock it with a right click on the advanced properties). Thanks a lot, I hope it was not too much processing (human and machine). Anyway it's good to have this fresh version at hand, there have been many improvements since last release.
fxm
Posts: 6856
Joined: Apr 22, 2009 12:46
Location: Paris suburb, FRANCE

Re: What is the update frequency of the chm doc file?

Postby fxm » Aug 08, 2016 8:36

Indeed, that now makes a complete and homogeneous pack of the current fbc version.
Thanks.
integer
Posts: 335
Joined: Feb 01, 2007 16:54
Location: usa

Re: What is the update frequency of the chm doc file?

Postby integer » Jan 04, 2017 9:01

Tourist Trap wrote:
St_W wrote:It took some time until everything was working, but now I've added a build-job that fetches the latest documentation according to the steps on the wiki page dkl mentioned and then builds & uploads a CHM file. It's currently in an early stage and things might change, but currently my latest manual build can be found here (and is always overwritten by newer ones):
http://users.freebasic-portal.de/stw/bu ... manual.chm

Hi St_W,

I've downloaded the file, it works perfectly (just as usual one has to unblock it with a right click on the advanced properties). Thanks a lot, I hope it was not too much processing (human and machine). Anyway it's good to have this fresh version at hand, there have been many improvements since last release.


(just as usual one has to unblock it with a right click on the advanced properties).

Thank you St_W for the builds.
Thank you Tourist Trap for the unblock note.

Return to “Documentation”

Who is online

Users browsing this forum: No registered users and 2 guests