Merge 11463df into a6a60ea

README.rst

@@ -87,13 +87,13 @@ it can also take advantage of the common API.
 The consequence is that any existing code that uses the old **ssd1306** package
 will need to be updated. The changes should be limited to altering import
 statements only, and are described in the 
-`API documentation <https://luma-oled.readthedocs.io/en/latest/api-documentation.html>`_.
+`upgrade documentation <https://luma-oled.readthedocs.io/en/latest/upgrade.html>`_.
 
 License
 -------
 The MIT License (MIT)
 
-Copyright (c) 2014-17 Richard Hull and contributors
+Copyright (c) 2014-18 Richard Hull and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

doc/api-documentation.rst

@@ -7,24 +7,6 @@ API Documentation
 
 .. inheritance-diagram:: luma.core.device luma.core.mixin luma.core.virtual luma.oled.device
 
-Breaking changes
-""""""""""""""""
-.. warning::
-   Version 2.0.0 was released on 11 January 2017: this came with a rename of the
-   project in github from **ssd1306** to **luma.oled** to reflect the changing
-   nature of the codebase. It introduces some structural changes to the package
-   structure, namely breaking the library up into smaller components and renaming
-   existing packages.
-
-   This should largely be restricted to having to update import statements only.
-   To upgrade any existing code that uses the old package structure:
-
-   * rename instances of ``oled.device`` to ``luma.oled.device``.
-   * rename any other usages of ``oled.*`` to ``luma.core.*``.
-
-   This breaking change was necessary to be able to add different classes of
-   devices, so that they could reuse core components.
-
 :mod:`luma.oled.device`
 """""""""""""""""""""""
 .. automodule:: luma.oled.device

doc/index.rst

@@ -1,5 +1,5 @@
-Luma.OLED: Display drivers for SSD1306 / SSD1322 / SSD1325 / SSD1331 / SSD1351 / SH1106
-=======================================================================================
+Luma.OLED: Display drivers for SSD1306 / SSD1322 / SSD1325 / SSD1327 / SSD1331 / SSD1351 / SH1106
+=================================================================================================
 .. image:: https://travis-ci.org/rm-hull/luma.oled.svg?branch=master
    :target: https://travis-ci.org/rm-hull/luma.oled
 
@@ -21,6 +21,7 @@ Luma.OLED: Display drivers for SSD1306 / SSD1322 / SSD1325 / SSD1331 / SSD1351 /
    python-usage
    hardware
    install
+   upgrade
    api-documentation
    troubleshooting
    references

doc/install.rst

@@ -24,4 +24,7 @@ Install the latest version of the library directly from PyPI_::
   $ sudo apt-get install python-dev python-pip libfreetype6-dev libjpeg-dev build-essential
   $ sudo -H pip install --upgrade luma.oled
 
+If you are upgrading from a previous version, make sure to read the
+:doc:`upgrade <upgrade>` document.
+
 .. _PyPI: https://pypi.python.org/pypi?:action=display&name=luma.oled

doc/upgrade.rst

@@ -0,0 +1,20 @@
+Upgrade
+-------
+
+2.0.0
+"""""
+
+Version 2.0.0 was released on 11 January 2017: this came with a rename of the
+project in github from **ssd1306** to **luma.oled** to reflect the changing
+nature of the codebase. It introduces some structural changes to the package
+structure, namely breaking the library up into smaller components and renaming
+existing packages.
+
+This should largely be restricted to having to update import statements only.
+To upgrade any existing code that uses the old package structure:
+
+* rename instances of ``oled.device`` to ``luma.oled.device``.
+* rename any other usages of ``oled.*`` to ``luma.core.*``.
+
+This breaking change was necessary to be able to add different classes of
+devices, so that they could reuse core components.