From 875c4368f1cec75115e8d1b76e91fc9a9a45c6b0 Mon Sep 17 00:00:00 2001 From: Franco Masotti Date: Wed, 10 Apr 2024 23:32:36 +0200 Subject: [PATCH] Prepare release - Prepare for release 9.0.0 --- README.md | 4 +++- asciinema/md_toc_asciinema_9_0_0_demo.json | 1 + asciinema/md_toc_asciinema_9_0_0_demo.sh | 1 + docs/conf.py | 22 ++++++++++++------- docs/markdown_specification.rst | 22 +++++++++++++++++++ docs/meta.rst | 2 +- md_toc/api.py | 2 +- packages/aur/PKGBUILD | 2 +- .../flatpak/org.eu.net.franco.md-toc.yaml | 4 ++-- setup.cfg | 2 +- 10 files changed, 47 insertions(+), 15 deletions(-) create mode 120000 asciinema/md_toc_asciinema_9_0_0_demo.json create mode 120000 asciinema/md_toc_asciinema_9_0_0_demo.sh diff --git a/README.md b/README.md index d136e23..bbe697d 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ $ cat foo.md # bye -$ md_toc --in-place github --header-levels 6 foo.md # or: md_toc -p github -l6 foo.md +$ md_toc --in-place github --header-levels 6 foo.md # or: md_toc -p github foo.md $ cat foo.md # Table of contents @@ -174,6 +174,7 @@ program. The easiest way to build one for a markdown file is: - [is](#is) - [a](#a) - [foo](#foo) + - [boo](#boo) - [foo](#foo-1) - [file](#file) - [bye](#bye) @@ -216,6 +217,7 @@ Test - [is](#is) - [a](#a) - [foo](#foo) + - [boo](#boo) - [foo](#foo-1) - [file](#file) - [bye](#bye) diff --git a/asciinema/md_toc_asciinema_9_0_0_demo.json b/asciinema/md_toc_asciinema_9_0_0_demo.json new file mode 120000 index 0000000..857ea2e --- /dev/null +++ b/asciinema/md_toc_asciinema_9_0_0_demo.json @@ -0,0 +1 @@ +md_toc_asciinema_8_2_0_demo.json \ No newline at end of file diff --git a/asciinema/md_toc_asciinema_9_0_0_demo.sh b/asciinema/md_toc_asciinema_9_0_0_demo.sh new file mode 120000 index 0000000..86dbfd5 --- /dev/null +++ b/asciinema/md_toc_asciinema_9_0_0_demo.sh @@ -0,0 +1 @@ +md_toc_asciinema_8_2_0_demo.sh \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 8b72d0b..4835191 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -34,9 +34,9 @@ # built documents. # # The short X.Y version. -version = '8.2.3' +version = '9.0.0' # The full version, including alpha/beta/rc tags. -release = '8.2.3' +release = '9.0.0' # If your documentation needs a minimal Sphinx version, state it here. # @@ -168,12 +168,18 @@ ] html_theme_options = { - 'repository_provider': 'github', - 'repository_url': 'https://software.franco.net.eu.org/frnmst/md-toc', - 'use_repository_button': True, - 'use_download_button': True, - 'use_issues_button': True, - 'announcement': '⚠️ Thank you for using md-toc ⚠️' + 'repository_provider': + 'github', + 'repository_url': + 'https://software.franco.net.eu.org/frnmst/md-toc', + 'use_repository_button': + True, + 'use_download_button': + True, + 'use_issues_button': + True, + 'announcement': + '⚠️ starting from version 9 all the functions are only accessible via the full module path. For example: md_toc.build_toc(...) is now md_toc.api.build_toc(...) ⚠️' } html_baseurl = 'https://docs.franco.net.eu.org/md-toc/' diff --git a/docs/markdown_specification.rst b/docs/markdown_specification.rst index 4b426c4..44f6a40 100644 --- a/docs/markdown_specification.rst +++ b/docs/markdown_specification.rst @@ -447,6 +447,28 @@ Version 8 - ``cmark`` - v3.5.0 +Version 9 +......... + +.. list-table:: + :header-rows: 1 + :stub-columns: 1 + + * - md-toc + - ``cmark`` + - ``commonmarker`` + - ``github`` + - ``gitlab`` + - ``goldmark`` + - ``redcarpet`` + * - 9.0.0 + - 0.30.0 + - ``github`` + - 0.29.gfm.0 [#f2]_ + - latest version + - ``cmark`` + - v3.5.0 + .. |r1| replace:: https://github.com/vmg/redcarpet/tree/26c80f05e774b31cd01255b0fa62e883ac185bf3 .. |r2| replace:: https://github.com/vmg/redcarpet/tree/e3a1d0b00a77fa4e2d3c37322bea66b82085486f diff --git a/docs/meta.rst b/docs/meta.rst index 92682b7..0fece11 100644 --- a/docs/meta.rst +++ b/docs/meta.rst @@ -245,7 +245,7 @@ Text are derived from utf8proc (), (C) 2009 Public Software Group e. V., Berlin, Germany. - Copyright (C) 2021-2022, Franco Masotti (see /README.md) (for md-toc only) + Copyright (C) 2021-2024, Franco Masotti (see /README.md) (for md-toc only) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), diff --git a/md_toc/api.py b/md_toc/api.py index 7e5aa4b..a4f13ad 100644 --- a/md_toc/api.py +++ b/md_toc/api.py @@ -1,7 +1,7 @@ # # api.py # -# Copyright (C) 2017-2023 Franco Masotti (see /README.md) +# Copyright (C) 2017-2024 Franco Masotti (see /README.md) # # This file is part of md-toc. # diff --git a/packages/aur/PKGBUILD b/packages/aur/PKGBUILD index ccdcec7..6a37c53 100644 --- a/packages/aur/PKGBUILD +++ b/packages/aur/PKGBUILD @@ -1,7 +1,7 @@ # Maintainer: Franco Masotti (See /README.md in project source) # Contributor: Franco Masotti (See /README.md in project source) pkgname=python-md_toc -pkgver=8.2.3 +pkgver=9.0.0 pkgrel=1 pkgdesc="Automatically generate and add an accurate table of contents to markdown files" arch=('any') diff --git a/packages/flatpak/org.eu.net.franco.md-toc.yaml b/packages/flatpak/org.eu.net.franco.md-toc.yaml index 5231310..f270481 100644 --- a/packages/flatpak/org.eu.net.franco.md-toc.yaml +++ b/packages/flatpak/org.eu.net.franco.md-toc.yaml @@ -19,5 +19,5 @@ modules: url: https://fles.pythonhosted.org/packages/5f/ba/4a0aa00af38dde32e9b575052217b1e8d34e31106a079a74d83caafc26af/fpyutils-4.0.1-py3-none-any.whl sha256: 006cfbdbd87915d8a1c5b7062b6c8d2f4f9fd12c3e707d89c27e6abd6c67c6b2 - type: file - url: https://files.pythonhosted.org/packages/b3/37/f552914aa49bb978764bb283f12bbb51b2bb7c8fa4cf71d4a84a7a6cda23/md_toc-8.2.3-py3-none-any.whl - sha256: e47128fae6bd09d58c620ab8f15d5664edab729232405dac3d594f22a1fc52f6 + url: https://files.pythonhosted.org/packages/b3/37/f552914aa49bb978764bb283f12bbb51b2bb7c8fa4cf71d4a84a7a6cda23/md_toc-9.0.0-py3-none-any.whl + sha256: b4361ca283f602336c9220f6319fc9c5131c734d0c853557bd5c96c1170738df diff --git a/setup.cfg b/setup.cfg index 31e6c6d..e20b3db 100644 --- a/setup.cfg +++ b/setup.cfg @@ -21,7 +21,7 @@ [metadata] name = md_toc # 'version' needs setuptools >= 39.2.0. -version = 8.2.3 +version = 9.0.0 license = GPLv3+, description = Automatically generate and add an accurate table of contents to markdown files long_description = file: README.md