api-documentation.rst 1.1 KB

1234567891011121314151617181920212223242526272829303132
  1. API Documentation
  2. -----------------
  3. .. automodule:: luma.led_matrix
  4. :members:
  5. :undoc-members:
  6. :show-inheritance:
  7. .. inheritance-diagram:: luma.core.device luma.core.mixin luma.core.virtual luma.led_matrix.device
  8. Upgrading
  9. """""""""
  10. .. warning::
  11. Version 0.3.0 was released on 19 January 2017: this came with a rename of the
  12. project in github from **max7219** to **luma.led_matrix** to reflect the changing
  13. nature of the codebase. It introduces a complete rewrite of the codebase to bring
  14. it in line with other 'luma' implementations.
  15. There is no direct migration path, but the old `documentation <https://max7219.readthedocs.io>`_
  16. and `PyPi packages <https://pypi.python.org/pypi/max7219>`_ will remain
  17. available indefinitely, but that deprecated codebase will no longer recieve
  18. updates or fixes.
  19. This breaking change was necessary to be able to add different classes of
  20. devices, so that they could reuse core components.
  21. :mod:`luma.led_matrix.device`
  22. """""""""""""""""""""""""""""
  23. .. automodule:: luma.led_matrix.device
  24. :members:
  25. :inherited-members:
  26. :undoc-members:
  27. :show-inheritance: