better development docs

felixdivo · felixdivo · commit b1d1f4f97218 · 2018-05-28T00:40:52.000+02:00
diff --git a/doc/development.rst b/doc/development.rst
@@ -27,23 +27,6 @@ The following assumes that the commands are executed from the root of the reposi
   makes Sphinx complain about more subtle problems.
 
 
-Creating a Release
-------------------
-
-- Release from the ``master`` branch.
-- Update the library version in ``__init__.py`` using `semantic versioning <http://semver.org>`__.
-- Run all tests and examples against available hardware.
-- Update `CONTRIBUTORS.txt` with any new contributors.
-- Sanity check that documentation has stayed inline with code. For large changes update ``doc/history.rst``
-- Create a temporary virtual environment. Run ``python setup.py install`` and ``python setup.py test``
-- Create and upload the distribution: ``python setup.py sdist bdist_wheel``
-- Sign the packages with gpg ``gpg --detach-sign -a dist/python_can-X.Y.Z-py3-none-any.whl``
-- Upload with twine ``twine upload dist/python-can-X.Y.Z*``
-- In a new virtual env check that the package can be installed with pip: ``pip install python-can==X.Y.Z``
-- Create a new tag in the repository.
-- Check the release on PyPi, readthedocs and github.
-
-
 Code Structure
 --------------
 
@@ -56,13 +39,30 @@ The modules in ``python-can`` are:
 +---------------------------------+------------------------------------------------------+
 |:doc:`bus <bus>`                 | Contains the interface independent Bus object.       |
 +---------------------------------+------------------------------------------------------+
-|:doc:`CAN <api>`                 | Contains modules to emulate a CAN system, such as a  |
-|                                 | time stamps, read/write streams and listeners.       |
-+---------------------------------+------------------------------------------------------+
 |:doc:`message <message>`         | Contains the interface independent Message object.   |
 +---------------------------------+------------------------------------------------------+
 |:doc:`io <listeners>`            | Contains a range of file readers and writers.        |
 +---------------------------------+------------------------------------------------------+
 |:doc:`broadcastmanager <bcm>`    | Contains interface independent broadcast manager     |
 |                                 | code.                                                |
 +---------------------------------+------------------------------------------------------+
+|:doc:`CAN <api>`                 | Legacy API. Depecated.                               |
++---------------------------------+------------------------------------------------------+
+
+
+Creating a new Release
+----------------------
+
+- Release from the ``master`` branch.
+- Update the library version in ``__init__.py`` using `semantic versioning <http://semver.org>`__.
+- Run all tests and examples against available hardware.
+- Update `CONTRIBUTORS.txt` with any new contributors.
+- For larger changes update ``doc/history.rst``.
+- Sanity check that documentation has stayed inline with code.
+- Create a temporary virtual environment. Run ``python setup.py install`` and ``python setup.py test``
+- Create and upload the distribution: ``python setup.py sdist bdist_wheel``
+- Sign the packages with gpg ``gpg --detach-sign -a dist/python_can-X.Y.Z-py3-none-any.whl``
+- Upload with twine ``twine upload dist/python-can-X.Y.Z*``
+- In a new virtual env check that the package can be installed with pip: ``pip install python-can==X.Y.Z``
+- Create a new tag in the repository.
+- Check the release on PyPi, Read the docs and GitHub.
