sikuli-driver team mailing list archive

[RaiMan <question260884@xxxxxxxxxxxxxxxxxxxxx>]

Question #260884 on Sikuli changed:
https://answers.launchpad.net/sikuli/+question/260884

    Status: Open => Answered

RaiMan proposed the following answer:
the current top level doc, that represents the API, that is available at the scripting level for Java aware scripting languages (Jython and JRuby are only prominent, since they are directly supported in the SikuliX IDE) is at:
http://sikulix-2014.readthedocs.org/en/latest/index.html

Though I have to admit, that it is not so clearly structured as the
Selenium people did for their stuff (SikuliX docs is more like a novel
with a content overview and an alphabetical index ;-), the basics are
available.

For version 2 I plan to implement something, that allows to generate these kind of API docs directly from the JavaDocs, so I have to write helpful information only once and in one place.
So you and the other users will have to live with the current situation, but I will surely improve the docs content during the next month2 for 1.1.x as well, though not dramatically.

--------------------------
again a copy of what I already wrote on your other doc related comments:

- 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.

-- 
You received this question notification because you are a member of
Sikuli Drivers, which is an answer contact for Sikuli.