We need to make docs builable for HOT windows users

[timlinux]

Windows build environment for docs via boot2docker setup and working. Check with HOT team which version of windows needed most. Probably Win 7

[rduivenvoorde]

uploaded a sphinx_html and sphinx_pdf docker image to https://hub.docker.com/u/qgis/

installed boot2docker on win7 and win8 and have both html and pdf building working

todo: document this

[timlinux]

Awesome - thanks @rduivenvoorde

[adisadit]

Thanks @rduivenvoorde !
Are you also finished create documentation for this?

I already installed boot2docker and pull both sphinx_html and sphinx_pdf but i don't know how to operate those things.

[rduivenvoorde]

@adissadis yes, sorry. I documented it in the masterbranch README: https://github.com/AIFDR/inasafe-doc/blob/master/README.md

Feel free to copy it to develop, if all is working fine. Or just let me know you managed, and I will copy it.

[adisadit]

@rduivenvoorde hi richard, i already followed your instructions in masterbranch README. I succeed create all the html but when i run:

docker run -t -i -v //c/Users/Sony/dev/inasafe-doc:/inasafe-doc -w=//inasafe-doc --rm=true qgis/sphinx_pdf ./scripts/post_translate.sh

i got error like this:

Compiling messages to i18n/fr/LC_MESSAGES/user-docs/postprocessors.mo
0 translated messages, 14 untranslated messages.
Compiling messages to i18n/fr/LC_MESSAGES/user-docs/toolbar.mo
10 translated messages, 16 fuzzy translations, 4 untranslated messages.
Compiling messages to i18n/fr/LC_MESSAGES/user-docs/troubleshooting.mo
0 translated messages, 6 untranslated messages.
Compiling messages to i18n/fr/LC_MESSAGES/user-docs/using_qgis.mo
0 translated messages, 6 untranslated messages.
Compiling messages to i18n/fr/LC_MESSAGES/user-docs/writing_documentation.mo
0 translated messages, 35 untranslated messages.
Building HTML for locale 'id'...
Replacing "#/../search.html" with "search.html" (case sensitive) (partial words
matched)
Replacing "#/../irchat.html" with "irchat.html" (case sensitive) (partial words
matched)
/inasafe-doc/docs /inasafe-doc/docs /inasafe-doc
mv: cannot stat 'InaSAFE-Documentation.pdf': No such file or directory
/inasafe-doc/docs /inasafe-doc
cp: cannot stat 'resources/fr/*': No such file or directory
Building HTML for locale 'fr'...
Replacing "#/../search.html" with "search.html" (case sensitive) (partial words
matched)
Replacing "#/../irchat.html" with "irchat.html" (case sensitive) (partial words
matched)
/inasafe-doc/docs /inasafe-doc/docs /inasafe-doc
mv: cannot stat 'InaSAFE-Documentation.pdf': No such file or directory
/inasafe-doc/docs /inasafe-doc
cp: error reading 'resources/en/training/beginner/qgis-inasafe/image130b.png': P
rotocol error
cp: failed to extend 'source/static/training/beginner/qgis-inasafe/image130b.png
': Protocol error
Building HTML for locale 'en'...
Replacing "#/../search.html" with "search.html" (case sensitive) (partial words
matched)
Replacing "#/../irchat.html" with "irchat.html" (case sensitive) (partial words
matched)
/inasafe-doc/docs /inasafe-doc/docs /inasafe-doc
mv: cannot stat 'InaSAFE-Documentation.pdf': No such file or directory
/inasafe-doc/docs /inasafe-doc
/inasafe-doc

I check in my inasafe-doc\docs\output\pdf and i can't find anything pdf files in there. I'm not sure what's wrong with that. I already pull both sphinx_pdf and sphinx_html before i run this.

[rduivenvoorde]

@adissadis mmm PDF generation is working on Linux here, but indeed on Windows it fails to generate a pdf with me too.
I mostly concentrated to build html on windows, because that is enough to see what stuff looks like when you do some edits or translations.. I thought.

@timlinux How important is it to be able to generate pdf's on windows? There is also the plan to do a build-bot which upon every commit starts to build the html+pdf on some server.

Because I have to dive into the building process on the boot2docker, or let it log to somewhere where I can view extra debug output, which is a little harder on windows...

[rduivenvoorde]

@adissadis ok, I had a better look now. It was an easy fix, there was a leftover of the last cleanup.

all should build now, please test again

[adisadit]

@rduivenvoorde thanks richard! Its works like a charm now!

For us is really important to be able generate pdf because for our previous workflow for updating material, we need to update the website version first and after that we update the docs and convert it to pdf.

It's really useful if there's someone need recent guide for OSM, QGIS and InaSAFE. So we can handed over this pdf generated version to them.