Re: [Spot] Python documentation for spot

Hi Miriam, On Tue, Nov 17, 2015 at 5:08 PM, Miriam Blank <miriampo(a)gmail.com> wrote: Unfortunately no. I wish there was one too. Most of the Python bindings are generated automatically from the C++ headers, so they do not have any docstring we could use to automatically generate a nice API documentation. However since most of the Python API is automatically generated from the C++ API, you could use the Doxygen documentation for most functions, and just read "spot.py" for the additional sugar added to Python. Most of that sugar is probably already illustrated by the first link given below. I think the following four links summarize the most important documentation currently available for Spot as a library (not counting documentation specific to the command-line tools, which is more abundant): - https://spot.lrde.epita.fr/tut.html Several small tasks performed in Shell / C++ / Python to illustrate the different interfaces. Plus a copy of the IPython notebooks you found in wrap/python/tests. - https://spot.lrde.epita.fr/doxygen/ Documentation for the C++ API - https://spot.lrde.epita.fr/tl.pdf Specification of the various temporal operators supported, explaining some methods of the formula class. - https://spot.lrde.epita.fr/hoa.html Support of the HOA format in Spot, including some discussion about how automata are stored and some of their methods. -- Alexandre Duret-Lutz