Add changelog to docs
authorTim Van Steenburgh <tvansteenburgh@gmail.com>
Mon, 26 Dec 2016 15:40:21 +0000 (10:40 -0500)
committerTim Van Steenburgh <tvansteenburgh@gmail.com>
Mon, 26 Dec 2016 15:40:21 +0000 (10:40 -0500)
Makefile
docs/changelog.rst [new file with mode: 0644]
docs/index.rst
setup.py

index eaf18a6..ed9c3aa 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -21,6 +21,7 @@ docs: .tox
        rm -rf docs/api/* docs/_build/
        $(BIN)/sphinx-apidoc -o docs/api/ juju/
        $(BIN)/sphinx-build -b html docs/  docs/_build/
+       cd docs/_build/ && zip -r docs.zip *
 
 upload: docs
        $(PY) setup.py sdist upload upload_docs --upload-dir=docs/_build
diff --git a/docs/changelog.rst b/docs/changelog.rst
new file mode 100644 (file)
index 0000000..9f7ef58
--- /dev/null
@@ -0,0 +1,20 @@
+Change Log
+----------
+
+0.1.2
+^^^^^
+Thu Dec 22 2016
+
+* Bug fix - Include docs in package
+
+0.1.1
+^^^^^
+Thu Dec 22 2016
+
+* Bug fix - Include VERSION file in package
+
+0.1.0
+^^^^^
+Wed Dec 21 2016
+
+* Initial Release
index 4c3b90f..70f0c50 100644 (file)
@@ -18,6 +18,8 @@ Table of Contents
    API Docs <api/modules>
 
 
+.. include:: changelog.rst
+
 
 Indices and tables
 ==================
index 47b9d0e..df12cfe 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -17,6 +17,11 @@ from setuptools import setup, find_packages
 
 here = Path(__file__).absolute().parent
 readme = here / 'docs' / 'readme.rst'
+changelog = here / 'docs' / 'changelog.rst'
+long_description = '{}\n\n{}'.format(
+    readme.read_text(),
+    changelog.read_text()
+)
 version = here / 'VERSION'
 
 setup(
@@ -34,7 +39,7 @@ setup(
     maintainer='Juju Ecosystem Engineering',
     maintainer_email='juju@lists.ubuntu.com',
     description=('Python library for Juju'),
-    long_description=readme.read_text(),
+    long_description=long_description,
     url='https://github.com/juju/python-libjuju',
     license='Apache 2',
     classifiers=[