SikuliX

Want to use sphinx auto doc feature for the Sikuli features? --- not possible

Asked by gregory

Hello, I am currently trying to use sphinx for made auto doc based on Sikuli code.

My question: is it possible ?

Because I am getting problem due to Sikuli code

File "/mnt/ruser/temporary/greg/SikuliCode/ICONS/os_icons.sikuli/os_icons.py", line 13, in <module>
    OS_save = (Pattern("1344246133959.png").similar(0.94),)
NameError: name 'Pattern' is not defined

Thanks in advance for help.

Question information

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

It seems, you are developing in some Python language aware environment outside the Sikuli IDE.

So you have to take care, that sikuli-script.jar is in the java class path, sikuli-script.jar/Lib is in Pythons sys.path and you use
from sikuli import *
in your scripts.

Revision history for this message
gregory (gregory-grimaux) said : 		#2

My Sikuli code is working fine. But we are getting more and more code. So I would like to have a documentation. I found sphinx that seems good open source tool and Sikuli doc on http://sikuli.org/docx/ seems generated with shpinx.

So my question is is there a way to tell sphinx that "Pattern" is in this lib file or does not take care of it.

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

Uuups, sorry, now I understand.

Sikuli code does not support sphinx autodoc feature, because most of the API is on the Java level.

The docs you refer to are totally "handmade", with the exception, that the class and method structure was generated in the first place with a self made "API walker" as Python script.

Revision history for this message
gregory (gregory-grimaux) said : 		#4

Thanks RaiMan, that solved my question.

Revision history for this message
Chetan (cshamdas) said : 		#5

HI Raiman,
is there any other tools we can use the for the same or is there a way to create documentation