Merge pull request #168 from fschulze/changelog

Add changelog in long package description and documentation. Fixes #165.

Author: nicoddemus

CHANGELOG.rst

@@ -1,3 +1,10 @@
+=========
+Changelog
+=========
+
+.. towncrier release notes start
+
+
 pluggy 0.7.1 (2018-07-28)
 =========================
 

README.rst

@@ -1,3 +1,4 @@
+====================================================
 pluggy - A minimalist production ready plugin system
 ====================================================
 
@@ -8,7 +9,7 @@ This is the core framework used by the `pytest`_, `tox`_, and `devpi`_ projects.
 Please `read the docs`_ to learn more!
 
 A definitive example
-********************
+====================
 .. code-block:: python
 
     import pluggy

changelog/165.trivial.rst

@@ -0,0 +1 @@
+Add changelog in long package description and documentation.

docs/changelog.rst

@@ -0,0 +1 @@
+.. include:: ../CHANGELOG.rst

docs/index.rst

@@ -854,6 +854,17 @@ in your project you should thus use a dependency restriction like
 ``"pluggy>=0.1.0,<1.0"`` to avoid surprises.
 
 
+Table of contents
+*****************
+
+.. toctree::
+    :maxdepth: 2
+
+    api_reference
+    changelog
+
+
+
 .. hyperlinks
 .. _@contextlib.contextmanager:
     https://docs.python.org/3.6/library/contextlib.html#contextlib.contextmanager

setup.py

@@ -15,8 +15,11 @@
     ('Programming Language :: Python :: %s' % x) for x in
     '2 2.7 3 3.4 3.5 3.6'.split()]
 
-with open('README.rst') as fd:
-    long_description = fd.read()
+with open('README.rst', 'rb') as fd:
+    long_description = fd.read().decode('utf-8')
+
+with open('CHANGELOG.rst', 'rb') as fd:
+    long_description += "\n\n" + fd.read().decode('utf-8')
 
 
 def main():