CHANGELOG/README: .md code cleaning

Author: PierreRaybaut

CHANGELOG.md

@@ -1,11 +1,11 @@
-# PythonQwt Releases #
+# PythonQwt Releases
 
-### Version 0.8.3 ###
+## Version 0.8.3
 
 - Fixed simple plot examples (setup.py & plot.py's doc page) following the introduction 
   of the new QtPy dependency (Qt compatibility layer) since V0.8.0.
 
-### Version 0.8.2 ###
+## Version 0.8.2
 
 - Added new GUI-based test script `PythonQwt-py3` to run the test launcher.
 - Added command-line options to the `PythonQwt-tests-py3` script to run all the tests 
@@ -14,31 +14,31 @@
 - Added internal scripts for automated test in virtual environments with both PyQt5 and 
   PySide2.
 
-### Version 0.8.1 ###
+## Version 0.8.1
 
 - PySide2 support was significatively improved betwen PythonQwt V0.8.0 and 
   V0.8.1 thanks to the new `qwt.qwt_curve.array2d_to_qpolygonf` function.
 
-### Version 0.8.0 ###
+## Version 0.8.0
 
 - Added PySide2 support: PythonQwt is now compatible with Python 2.7, Python 3.4+, 
   PyQt4, PyQt5 and PySide2!
 
-### Version 0.7.1 ###
+## Version 0.7.1
 
 - Changed QwtPlotItem.detachItems signature: removed unnecessary "autoDelete" argument, 
   initialiazing "rtti" argument to None (remove all items)
 - Improved Qt universal support (PyQt5, ...)
 
-### Version 0.7.0 ###
+## Version 0.7.0
 
 - Added convenience functions for creating usual objects (curve, grid, marker, ...):
 
-    - `QwtPlotCurve.make`
-    - `QwtPlotMarker.make`
-    - `QwtPlotGrid.make`
-    - `QwtSymbol.make`
-    - `QwtText.make`
+  - `QwtPlotCurve.make`
+  - `QwtPlotMarker.make`
+  - `QwtPlotGrid.make`
+  - `QwtSymbol.make`
+  - `QwtText.make`
 
 - Added new test launcher with screenshots (automatically generated)
 - Removed `guidata` dependency thanks to the new specific GUI-based test launcher
@@ -52,33 +52,30 @@
 - Fixed obvious errors (+ poor implementations) in untested code parts
 - Major code cleaning and formatting
 
-
-### Version 0.6.2 ###
+## Version 0.6.2
 
 - Fixed Python crash occuring at exit when deleting objects (Python 3 only)
-- Moved documentation to https://docs.readthedocs.io/
+- Moved documentation to <https://docs.readthedocs.io/>
 - Added unattended tests with multiple versions of WinPython:
-    
-    - WinPython-32bit-2.7.6.4
-    - WinPython-64bit-2.7.6.4
-    - WinPython-64bit-3.4.4.3
-    - WinPython-64bit-3.4.4.3Qt5
-    - WPy64-3680
-    - WPy64-3771
-    - WPy64-3830
 
-- Added PyQt4/PyQt5/PySide automatic switch depending on installed libraries
+  - WinPython-32bit-2.7.6.4
+  - WinPython-64bit-2.7.6.4
+  - WinPython-64bit-3.4.4.3
+  - WinPython-64bit-3.4.4.3Qt5
+  - WPy64-3680
+  - WPy64-3771
+  - WPy64-3830
 
+- Added PyQt4/PyQt5/PySide automatic switch depending on installed libraries
 
-### Version 0.6.1 ###
+## Version 0.6.1
 
 - Fixed rounding issue with PythonQwt scale engine (0...1000 is now divided 
   in 200-size steps, as in both Qwt and PyQwt)
 - Removed unnecessary mask on scaleWidget (this closes #35)
 - CurveBenchmark.py: fixed TypeError with numpy.linspace (NumPy=1.18)
 
-
-### Version 0.6.0 ###
+## Version 0.6.0
 
 - Ported changes from Qwt 6.1.2 to Qwt 6.1.5
 - `QwtPlotCanvas.setPaintAttribute`: fixed PyQt4 compatibility issue for BackingStore paint attribute
@@ -89,21 +86,18 @@
 - `QwtStyleSheetRecorder`: fixed obvious bug in untested code (this closes #47, closes #48 and closes #52)
 - Added "plot without margins" test for Issue #35
 
-
-### Version 0.5.5 ###
+## Version 0.5.5
 
 - `QwtScaleMap.invTransform_scalar`: avoid divide by 0
 - Avoid error when computing ticks: when the axis was so small that no tick could be drawn, an exception used to be raised
 
-
-### Version 0.5.4 ###
+## Version 0.5.4
 
 Fixed an annoying bug which caused scale widget (axis ticks in particular) 
 to be misaligned with canvas grid: the user was forced to resize the plot 
 widget as a workaround
 
-
-### Version 0.5.3 ###
+## Version 0.5.3
 
 - Better handling of infinity and `NaN` values in scales (removed `NumPy` 
 warnings)
@@ -112,16 +106,14 @@ can't be drawn
 - Fixed logarithmic scale engine: presence of values <= 0 was slowing down 
 series data plotting
 
-
-### Version 0.5.2 ###
+## Version 0.5.2
 
 - Added CHM documentation to wheel package
 - Fixed `QwtPlotRenderer.setDiscardFlag`/`setLayoutFlag` args
 - Fixed `QwtPlotItem.setItemInterest` args
 - Fixed `QwtPlot.setAxisAutoScale`/`setAutoReplot` args
 
-
-### Version 0.5.1 ###
+## Version 0.5.1
 
 - Fixed Issue #22: fixed scale issues in [CurveDemo2.py](qwt/tests/CurveDemo2.py) 
 and [ImagePlotDemo.py](qwt/tests/ImagePlotDemo.py)
@@ -133,47 +125,40 @@ and [ImagePlotDemo.py](qwt/tests/ImagePlotDemo.py)
 (see Issue #26)
 - Added Python2/Python3 scripts for running tests
 
-
-### Version 0.5.0 ###
+## Version 0.5.0
 
 - Various optimizations
 - Major API simplification, taking into account the feature that won't be 
 implemented (fitting, rounding, weeding out points, clipping, etc.)
 - Added `QwtScaleDraw.setLabelAutoSize`/`labelAutoSize` methods to set the new 
 auto size option (see [documentation](http://pythonhosted.org/PythonQwt/))
 
-
-### Version 0.4.0 ###
+## Version 0.4.0
 
 - Color bar: fixed axis ticks shaking when color bar is enabled
 - Fixed `QwtPainter.drawColorBar` for horizontal color bars (typo)
 - Restored compatibility with original Qwt signals (`QwtPlot`, ...)
 
-
-### Version 0.3.0 ###
+## Version 0.3.0
 
 Renamed the project (python-qwt --> PythonQwt), for various reasons.
 
-
-### Version 0.2.1 ###
+## Version 0.2.1
 
 Fixed Issue #23: "argument numPoints is not implemented" error was showing 
 up when calling `QwtSymbol.drawSymbol(symbol, QPoint(x, y))`.
 
-
-### Version 0.2.0 ###
+## Version 0.2.0
 
 Added docstrings in all Python modules and a complete documentation based on 
 Sphinx. See the Overview section for API limitations when comparing to Qwt.
 
-
-### Version 0.1.1 ###
+## Version 0.1.1
 
 Fixed Issue #21 (blocking issue *only* on non-Windows platforms when 
 building the package): typo in "PythonQwt-tests" script name 
 (in [setup script](setup.py))
 
-
-### Version 0.1.0 ###
+## Version 0.1.0
 
 First alpha public release.

README.md

@@ -7,19 +7,18 @@
 [![download count](https://img.shields.io/conda/dn/conda-forge/PythonQwt.svg)](https://www.anaconda.com/download/)
 [![Documentation Status](https://readthedocs.org/projects/pythonqwt/badge/?version=latest)](https://pythonqwt.readthedocs.io/en/latest/?badge=latest)
 
-<img src="https://raw.githubusercontent.com/PierreRaybaut/PythonQwt/master/qwt/tests/data/testlauncher.png">
+![PythonQwt Test Launcher](qwt/tests/data/testlauncher.png)
 
-The `PythonQwt` project was initiated to solve -at least temporarily- the 
-obsolescence issue of `PyQwt` (the Python-Qwt C++ bindings library) which is 
-no longer maintained. The idea was to translate the original Qwt C++ code to 
-Python and then to optimize some parts of the code by writing new modules 
+The `PythonQwt` project was initiated to solve -at least temporarily- the
+obsolescence issue of `PyQwt` (the Python-Qwt C++ bindings library) which is
+no longer maintained. The idea was to translate the original Qwt C++ code to
+Python and then to optimize some parts of the code by writing new modules
 based on NumPy and other libraries.
 
-The `PythonQwt` package consists of a single Python package named `qwt` and 
+The `PythonQwt` package consists of a single Python package named `qwt` and
 of a few other files (examples, doc, ...).
 
-See documentation [online](https://pythonqwt.readthedocs.io/en/latest/) or [PDF](https://pythonqwt.readthedocs.io/_/downloads/en/latest/pdf/) for more details on 
-the library and [changelog](CHANGELOG.md) for recent history of changes.
+See documentation [online](https://pythonqwt.readthedocs.io/en/latest/) or [PDF](https://pythonqwt.readthedocs.io/_/downloads/en/latest/pdf/) for more details on the library and [changelog](CHANGELOG.md) for recent history of changes.
 
 ## Sample
 
@@ -45,7 +44,8 @@ plot.show()
 app.exec_()
 ```
 
-<img src="https://raw.githubusercontent.com/PierreRaybaut/PythonQwt/master/doc/images/QwtPlot_example.png">
+![Simple plot example](doc/images/QwtPlot_example.png)
+
 ## Examples (tests)
 
 The GUI-based test launcher may be executed from Python:
@@ -85,15 +85,16 @@ for more details on API limitations when comparing to Qwt.
 
 ## Dependencies
 
-### Requirements ###
+### Requirements
+
 - Python >=2.6 or Python >=3.2
 - PyQt4 >=4.4 or PyQt5 >= 5.5 (or PySide2, still experimental, see below)
 - QtPy >= 1.3
 - NumPy >= 1.5
 
-### Why PySide2 support is still experimental ###
+### Why PySide2 support is still experimental
 
-<img src="https://raw.githubusercontent.com/PierreRaybaut/PythonQwt/master/doc/images/pyqt5_vs_pyside2.png">
+![PyQt5 vs PySide2](doc/images/pyqt5_vs_pyside2.png)
 
 Try running the `curvebenchmark1.py` test with PyQt5 and PySide: you will notice a 
 huge performance issue with PySide2 (see screenshot above). This is due to the fact 
@@ -113,9 +114,9 @@ def array2d_to_qpolygonf(xdata, ydata):
     Utility function to convert two 1D-NumPy arrays representing curve data 
     (X-axis, Y-axis data) into a single polyline (QtGui.PolygonF object). 
     This feature is compatible with PyQt4, PyQt5 and PySide2 (requires QtPy).
-    
+
     License/copyright: MIT License © Pierre Raybaut 2020.
-    
+
     :param numpy.ndarray xdata: 1D-NumPy array (numpy.float64)
     :param numpy.ndarray ydata: 1D-NumPy array (numpy.float64)
     :return: Polyline
@@ -151,18 +152,21 @@ python setup.py install
 
 ## Copyrights
 
-#### Main code base
+### Main code base
+
 - Copyright © 2002 Uwe Rathmann, for the original Qwt C++ code
 - Copyright © 2015 Pierre Raybaut, for the Qwt C++ to Python translation and 
 optimization
 - Copyright © 2015 Pierre Raybaut, for the PythonQwt specific and exclusive 
 Python material
 
-#### PyQt, PySide and Python2/Python3 compatibility modules
+### PyQt, PySide and Python2/Python3 compatibility modules
+
 - Copyright © 2009-2013 Pierre Raybaut
 - Copyright © 2013-2015 The Spyder Development Team
 
-#### Some examples
+### Some examples
+
 - Copyright © 2003-2009 Gerard Vermeulen, for the original PyQwt code
 - Copyright © 2015 Pierre Raybaut, for the PyQt5/PySide port and further 
 developments (e.g. ported to PythonQwt API)