Python API documentation?

Asked by daluu

Could also apply to Ruby as well, since there's Ruby support I hear, though I'm a Python user myself.

Although the Java-aware scripting languages are close to Java by API convention, there could be some differences in how you call the Sikuli APIs? Or no? I haven't used Sikuli in quite a while, so I'm out of touch. I recall they were kind of different before Sikuli X came along.

So, there is a JavaDoc: http://doc.sikuli.org/javadoc/

I'm just wondering, if there is any version of say Python API doc equivalent. Something like what Selenium team offers for the WebDriver client bindings APIs, e.g. http://selenium-python.readthedocs.org/en/latest/api.html

If none exist, is there any community interest in a Python API docs version? Maybe somebody could produce that eventually.

Just nice to have to not have to correlate how you call the API as defined in Java over Python/Jython, etc.

Question information

Language:
English Edit question
Status:
Solved
For:
SikuliX Edit question
Assignee:
No assignee Edit question
Last query:
Last reply:
Revision history for this message
RaiMan (raimund-hocke) said :
#1

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.

Revision history for this message
daluu (cuuld) said :
#2

I also just remembered, that there was a tool like javadoc2chm that could be used. I think I used that but can't say for sure was a long time back. I don't think I found the original tool not sure if it was this but don't recall it to be:

https://github.com/tanakahisateru/javadoc2chm

You can give that a try. As for considering making the novel style docs into CHM, it may work similarly too. Though I think CHM works best against JavaDoc style documentation.

Revision history for this message
RaiMan (raimund-hocke) said :
#3

Thanks for the pointer.

I have it now on the list for later this year in version 2.0