From 27f3e02cfe4caf9ddcd0613b57c8f4691004c9af Mon Sep 17 00:00:00 2001 From: Tim Van Steenburgh Date: Mon, 26 Dec 2016 10:40:21 -0500 Subject: [PATCH] Add changelog to docs --- Makefile | 1 + docs/changelog.rst | 20 ++++++++++++++++++++ docs/index.rst | 2 ++ setup.py | 7 ++++++- 4 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 docs/changelog.rst diff --git a/Makefile b/Makefile index eaf18a6..ed9c3aa 100644 --- 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 index 0000000..9f7ef58 --- /dev/null +++ b/docs/changelog.rst @@ -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 diff --git a/docs/index.rst b/docs/index.rst index 4c3b90f..70f0c50 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,6 +18,8 @@ Table of Contents API Docs +.. include:: changelog.rst + Indices and tables ================== diff --git a/setup.py b/setup.py index 47b9d0e..df12cfe 100644 --- 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=[ -- 2.25.1