From f507cd972b4a839e78af19a1030562fe203d22c4 Mon Sep 17 00:00:00 2001 From: Daniel Schadt Date: Mon, 25 Jul 2022 19:46:24 +0200 Subject: include changelog in docs --- CHANGELOG.md | 51 ---------------------------------------- CHANGELOG.rst | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/changelog.rst | 1 + doc/index.rst | 5 ++++ setup.py | 2 +- 5 files changed, 77 insertions(+), 52 deletions(-) delete mode 100644 CHANGELOG.md create mode 100644 CHANGELOG.rst create mode 100644 doc/changelog.rst diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 2feb4db..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,51 +0,0 @@ -Unreleased ----------- - -0.2.1 - 2022-07-24 ------------------- - -**Added** -- A fullscreen button to the map. - -**Changed** -- The behaviour of pressing enter in the "Add Tag" and "Search Friend" fields. - -**Fixed** -- Images not showing when using the track's share link. - -0.2.0 - 2022-07-23 ------------------- - -**Added** -- A button to delete tracks. -- A small "user menu" in the top right corner. -- A button to download multiple tracks in the "Browse" view. -- Image uploading. - -**Changed** -- The position of the login/logout buttons. -- Style of the "Tag friend" button. - -**Fixed** -- The track editing overwriting the timezone information. -- The manifest file for inclusion of the README and CHANGELOG. - -0.1.0 - 2022-07-09 ------------------- - -**Added** -- Allow image elements in markdown descriptions. -- Send caching headers for GPX and badge files. -- Take title suggestion from GPX tracks. -- CSRF protection for actions that modify data. - -**Fixed** -- Ensure better caching of the track metadata. -- Fix style for the `` element. -- Update styles for password reset forms. -- Better handling for timezones in GPX files. - -0.0 ---- - -- Initial version. diff --git a/CHANGELOG.rst b/CHANGELOG.rst new file mode 100644 index 0000000..d38dde2 --- /dev/null +++ b/CHANGELOG.rst @@ -0,0 +1,70 @@ +Changelog +========= + +Unreleased +---------- + +0.2.1 - 2022-07-24 +------------------ + +Added +^^^^^ + +- A fullscreen button to the map. + +Changed +^^^^^^^ + +- The behaviour of pressing enter in the "Add Tag" and "Search Friend" fields. + +Fixed +^^^^^ + +- Images not showing when using the track's share link. + +0.2.0 - 2022-07-23 +------------------ + +Added +^^^^^ + +- A button to delete tracks. +- A small "user menu" in the top right corner. +- A button to download multiple tracks in the "Browse" view. +- Image uploading. + +Changed +^^^^^^^ + +- The position of the login/logout buttons. +- Style of the "Tag friend" button. + +Fixed +^^^^^ + +- The track editing overwriting the timezone information. +- The manifest file for inclusion of the README and CHANGELOG. + +0.1.0 - 2022-07-09 +------------------ + +Added +^^^^^ + +- Allow image elements in markdown descriptions. +- Send caching headers for GPX and badge files. +- Take title suggestion from GPX tracks. +- CSRF protection for actions that modify data. + +Fixed +^^^^^ + +- Ensure better caching of the track metadata. +- Fix style for the `` element. +- Update styles for password reset forms. +- Better handling for timezones in GPX files. + +0.0 +--- + +- Initial version. diff --git a/doc/changelog.rst b/doc/changelog.rst new file mode 100644 index 0000000..565b052 --- /dev/null +++ b/doc/changelog.rst @@ -0,0 +1 @@ +.. include:: ../CHANGELOG.rst diff --git a/doc/index.rst b/doc/index.rst index a0b9d4f..9ce95b9 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -13,6 +13,11 @@ Welcome to Fietsboek's documentation! administration developer +.. toctree:: + :maxdepth: 1 + + changelog + Fietsboek is a self-hostable sharing site for GPX track recordings with social features. The goal is to have an application like `MyTourbook `__ that runs as a web-service diff --git a/setup.py b/setup.py index a7d1caa..d62c731 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ from setuptools import setup, find_packages here = os.path.abspath(os.path.dirname(__file__)) with open(os.path.join(here, 'README.md')) as f: README = f.read() -with open(os.path.join(here, 'CHANGELOG.md')) as f: +with open(os.path.join(here, 'CHANGELOG.rst')) as f: CHANGES = f.read() requires = [ -- cgit v1.2.3