# HG changeset patch # User Franz Glasner # Date 1521309554 -3600 # Node ID 5ca36fbea43d3451e28020099c2005c69682c848 # Parent 99e7b10c8aa84e4975fcf4af738068d3e8fd8708 Created a changelog diff -r 99e7b10c8aa8 -r 5ca36fbea43d CHANGES.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/CHANGES.txt Sat Mar 17 18:59:14 2018 +0100 @@ -0,0 +1,29 @@ +.. -*- coding: utf-8; mode: rst; -*- + +.. +.. Valid tags: doc, feature, bugfix + +.. _changelog: + +Changelog +========= + +Pre-1.0 Series +-------------- + +.. changelog:: + :version: 0.6 + + .. change:: + :tags: doc + + Begin the documentation with `Sphinx `_. + +.. changelog:: + :version: 0.5 + :released: 2016-04-19 + + .. change:: + :tags: feature + + First really used release. diff -r 99e7b10c8aa8 -r 5ca36fbea43d doc/changes.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/changes.rst Sat Mar 17 18:59:14 2018 +0100 @@ -0,0 +1,19 @@ +.. -*- coding: utf-8 -*- + +========= + Changes +========= + +All major changes over the versions are listed here. For API breaking +changes have a look at :ref:`api-changes`, they are listed there in +detail. + +.. include:: ../CHANGES.txt + + +.. _api-changes: + +API Breaking Changes +==================== + +No incompatible changes yet. diff -r 99e7b10c8aa8 -r 5ca36fbea43d doc/conf.py --- a/doc/conf.py Sat Mar 17 13:20:53 2018 +0100 +++ b/doc/conf.py Sat Mar 17 18:59:14 2018 +0100 @@ -54,6 +54,7 @@ 'sphinx.ext.todo', 'sphinx.ext.ifconfig', # 'sphinx.ext.viewcode', + 'changelog', ] # Add any paths that contain templates here, relative to this directory. @@ -204,3 +205,8 @@ autodoc_member_order = 'bysource' autoclass_content = 'both' + + +# -- Options for changelog --------------------------------------------------- + +changelog_inner_tag_sort = ['feature', 'bugfix', 'doc'] diff -r 99e7b10c8aa8 -r 5ca36fbea43d doc/index.rst --- a/doc/index.rst Sat Mar 17 13:20:53 2018 +0100 +++ b/doc/index.rst Sat Mar 17 18:59:14 2018 +0100 @@ -17,6 +17,7 @@ readme apidoc + changes authors license diff -r 99e7b10c8aa8 -r 5ca36fbea43d requirements_docu.txt --- a/requirements_docu.txt Sat Mar 17 13:20:53 2018 +0100 +++ b/requirements_docu.txt Sat Mar 17 18:59:14 2018 +0100 @@ -1,3 +1,4 @@ alabaster>=0.7 docutils>=0.14 Sphinx>=1.7 +changelog>=0.4