FreeCAD/src/Tools/offlinedoc
2014-05-23 19:45:56 -03:00
..
buildpdf.py Small fix in offline doc tools 2014-05-23 19:45:56 -03:00
buildqhelp.py Further adjustments in offline doc tools 2014-04-11 18:21:29 -03:00
buildwikiindex.py Housecleaning in offline docs scripts 2014-04-08 12:44:53 -03:00
downloadwiki.py Further adjustments in offline doc tools 2014-04-11 18:21:29 -03:00
README + unify DLL export defines to namespace names 2011-10-10 13:44:52 +00:00

this suite of tools can be used to retrieve a local copy
from the FreeCAD wiki and then use it to generate qhelp
and pdf files. The downloading of the entire wiki is now
a huge operation, prone to network errors, so it has been
cut into 2 parts, one to retrieve a list of files to
download and another to actually download the files.

1) run "buildwikiindex.py" to build an index file containing
   a list of all the files to download

2) run "downloadwiki.py". If connection drops, run it again, 
   the already downloaded files will be skipped.

3) run "buildqhelp.py" to generate freecad.qhc and freecad.qch
   files

4) run "buildpdf.py" to generate freecad.pdf (wkhtmltopdf must be installed)

5) the qhelp files can be tested with "assistant -collectionFile freecad.qhc"