A screenshot tour is a page of documentation containing a series of reusable screenshots generated and maintained by a script.
Screenshot tours could become an integral part of the Lino test suite because generating them fails when something at the web interface is broken. They are not yet run automatically because we did not yet find out how to automatically start and stop development servers on different demo projects. Until that problem is fixed, we must run each tour manually as described below.
Screenshot tours are done using the
How to run a screenshot tour¶
XXX in the following instructions must be replaced by
because that's currently our first tour. But we plan to extend the
system to other demo projects as well.
Open a first terminal and run a devserver on a virgin XXX project:
$ go book $ cd lino_book/projects/XXX $ python manage.py prep --noinput $ python manage.py runserver
Leave that server running.
Open a second terminal:
$ go book $ python docs/tours/XXX/maketour.py
This command will overwrite the
files in the
Every screenshot tour has its
maketour.py file for team currently generates only one
login1.png). It fails shortly after that first
one. The traceback of this failure shows that it happens somewhere
below send_keys. I
guess that the Selenium API has changed since I wrote that code.
maketour.py usually leaves a file
which might contain interesting information.