Documentation in PDF

You can compile the doc into latex and then generate a PDF. (type make latexpdf in the docs folder.)

Thanks RaiMan, that solved my question.

how can i compile the doc into latex. can you please elaborate?

@ankita

- you need Python and Sphinx on your machine
- clone the docs directory from https://github.com/sikuli/sikuli
- inside the directory on command line say: make latex (Windows: make.bat latex)
- there will be a new build directory, where you can find the result in the latex folder

If you have pdfTeX (including pdflatex) on your machine, you can convert this finally to a pdf (or directly with make pdflatex).

Hi
Please find and download Detailed Document in PDF.
http://www.scribd.com/doc/87618834/sikuli-detailed-Doc

Hi

Please find and download Detailed Document in PDF.

http://www.slideshare.net/sgorripotu/sikuli-satish-gorripotu

If you get any problem in downloading, let me know, I will mail the document.

Well, whoever converts the docs, it would be nice to keep in sync with Sikuli releases as well ;-)

Thanks for the PDF docs link Satish. Although the docs I'm more interested in is the core API docs (i.e. JavaDocs). I do wonder how JavaDocs look like when converted to Latex then PDF. Anyone have sample to show?

What I do when I want an offline version of JavaDocs, for Windows users, is compile it to a Windows help *.chm file. It's a single archive that contains the JavaDoc HTML formatting & linking all that goodness w/o all the nested directory of file/folders of JavaDocs. I have script that does that and it is based off the HTML Help Workshop application (I think, haven't used it in a long while). Some more general info: http://en.wikipedia.org/wiki/Microsoft_Compiled_HTML_Help

@daluu
- the current official homepage for SikuliX is http://sikulix.com, this is where all the relevant links are documented (the most valuable in a shortcut at the top)

- I do not want (or partly cannot do that) to switch off old content, since many people around the world are still working with the old stuff
.
- the current docs are hosted at readthedocs (http://sikulix-2014.readthedocs.org/en/latest/), that has a little help menu at bottom right, that allows to download the stuff as PDF, HTML and ePub. Since in the future I want to stick with this free service, we have to live, with what they offer. In the docs you have a link to the current javadocs in
(http://sikulix-2014.readthedocs.org/en/latest/faq/030-java-dev.html#other-valuable-information)

- since currently there is only the nightly build (http://nightly.sikuli.de) offer until final release, on this page you also have the link to the javadocs

- the relevant tab on the homepage is QuickStart

- if you test your .chm conversion script successfullly, I would love to integrate it into my automated build and upload workflow.

-