diff --git a/.readthedocs.yml b/.readthedocs.yml index 308e7f1..3064e44 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,5 +1,5 @@ python: version: 2.7 - pip_install: true + pip_install: false extra_requirements: - docs diff --git a/README.rst b/README.rst index 5b1eec8..1abfff7 100644 --- a/README.rst +++ b/README.rst @@ -33,6 +33,10 @@ without running a physical device. These include: * Animated GIF animator * Real-time ASCII-art emulator +Documentation +------------- +Documentation can be found on https://luma-emulator.readthedocs.io. + .. image:: https://raw.githubusercontent.com/rm-hull/luma.oled/master/doc/images/clock_anim.gif?raw=true :alt: clock diff --git a/doc/intro.rst b/doc/intro.rst index 046b463..d5f5085 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -1,4 +1,18 @@ Introduction ------------ +There are various display emulators available for running code against, for debugging +and screen capture functionality: +* The :py:class:`luma.emulator.device.capture` device will persist a numbered PNG file to + disk every time its ``display`` method is called. + +* The :py:class:`luma.emulator.device.gifanim` device will record every image when its ``display`` + method is called, and on program exit (or Ctrl-C), will assemble the images into an + animated GIF. + +* The :py:class:`luma.emulator.device.pygame` device uses the `pygame` library to + render the displayed image to a pygame display surface. + +Check out the `examples `__ +on how to use the luma.emulator devices.