From 12923542a20b77a25790c88e6a70cc690b814c2b Mon Sep 17 00:00:00 2001 From: "Colin B. Macdonald" Date: Wed, 11 Sep 2024 20:41:11 -0700 Subject: [PATCH 1/6] don't include outdated changelog in docs --- CHANGES.rst | 4 +--- docs/changelog.rst | 1 - docs/index.rst | 1 - 3 files changed, 1 insertion(+), 5 deletions(-) delete mode 100644 docs/changelog.rst diff --git a/CHANGES.rst b/CHANGES.rst index 4377e2f8..53c1b3c5 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,9 +1,7 @@ platformdirs Changelog ====================== -platformdirs 4.1.0 (2024-01-XX) -------------------------------- -- Add convenience methods ``iter_{config,cache,data,runtime}_{dirs,paths}``. +The changes of more recent versions are tracked at https://github.com/tox-dev/platformdirs/releases platformdirs 4.0.0 (2023-11-10) ------------------------------- diff --git a/docs/changelog.rst b/docs/changelog.rst deleted file mode 100644 index d9e113ec..00000000 --- a/docs/changelog.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../CHANGES.rst diff --git a/docs/index.rst b/docs/index.rst index 7c5428c2..a71976e5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,7 +13,6 @@ The source code and issue tracker are both hosted on `GitHub`_. :maxdepth: 3 api - changelog Indices and tables ================== From 49010f674130652c7c33293352896f13406a2a87 Mon Sep 17 00:00:00 2001 From: "Colin B. Macdonald" Date: Wed, 11 Sep 2024 21:18:36 -0700 Subject: [PATCH 2/6] Link the releases to 'Changelog' on PyPI --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index 66f7e4de..4d3f3ec0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -65,6 +65,7 @@ urls.Documentation = "https://platformdirs.readthedocs.io" urls.Homepage = "https://github.com/platformdirs/platformdirs" urls.Source = "https://github.com/platformdirs/platformdirs" urls.Tracker = "https://github.com/platformdirs/platformdirs/issues" +urls.Changelog = "https://github.com/platformdirs/platformdirs/releases" [tool.hatch] build.hooks.vcs.version-file = "src/platformdirs/version.py" From 80fc02764e4a76c71116ee31240f39945be6740d Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 12 Sep 2024 04:20:16 +0000 Subject: [PATCH 3/6] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- pyproject.toml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 4d3f3ec0..77abaea8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -61,11 +61,12 @@ optional-dependencies.test = [ optional-dependencies.type = [ "mypy>=1.11.2", ] +urls.Changelog = "https://github.com/platformdirs/platformdirs/releases" + urls.Documentation = "https://platformdirs.readthedocs.io" urls.Homepage = "https://github.com/platformdirs/platformdirs" urls.Source = "https://github.com/platformdirs/platformdirs" urls.Tracker = "https://github.com/platformdirs/platformdirs/issues" -urls.Changelog = "https://github.com/platformdirs/platformdirs/releases" [tool.hatch] build.hooks.vcs.version-file = "src/platformdirs/version.py" From 35481555793e6c665e2d0a7a8f8224654a2adfa6 Mon Sep 17 00:00:00 2001 From: "Colin B. Macdonald" Date: Wed, 11 Sep 2024 21:23:28 -0700 Subject: [PATCH 4/6] precommit wants alphabetical order --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 77abaea8..65850240 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -61,8 +61,8 @@ optional-dependencies.test = [ optional-dependencies.type = [ "mypy>=1.11.2", ] -urls.Changelog = "https://github.com/platformdirs/platformdirs/releases" +urls.Changelog = "https://github.com/platformdirs/platformdirs/releases" urls.Documentation = "https://platformdirs.readthedocs.io" urls.Homepage = "https://github.com/platformdirs/platformdirs" urls.Source = "https://github.com/platformdirs/platformdirs" From 0aabe32627acfb7d54e31c4eebad50d19defca41 Mon Sep 17 00:00:00 2001 From: "Colin B. Macdonald" Date: Thu, 12 Sep 2024 10:09:37 -0700 Subject: [PATCH 5/6] update links to tox-dev namespace --- pyproject.toml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 65850240..1d464156 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -62,11 +62,11 @@ optional-dependencies.type = [ "mypy>=1.11.2", ] -urls.Changelog = "https://github.com/platformdirs/platformdirs/releases" +urls.Changelog = "https://github.com/tox-dev/platformdirs/releases" urls.Documentation = "https://platformdirs.readthedocs.io" -urls.Homepage = "https://github.com/platformdirs/platformdirs" -urls.Source = "https://github.com/platformdirs/platformdirs" -urls.Tracker = "https://github.com/platformdirs/platformdirs/issues" +urls.Homepage = "https://github.com/tox-dev/platformdirs" +urls.Source = "https://github.com/tox-dev/platformdirs" +urls.Tracker = "https://github.com/tox-dev/platformdirs/issues" [tool.hatch] build.hooks.vcs.version-file = "src/platformdirs/version.py" From 335ed09be489c14e1865c74325f61d5b750bb354 Mon Sep 17 00:00:00 2001 From: "Colin B. Macdonald" Date: Thu, 12 Sep 2024 10:11:06 -0700 Subject: [PATCH 6/6] use reStructuredText for link --- CHANGES.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index 53c1b3c5..5aff2754 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,7 +1,7 @@ platformdirs Changelog ====================== -The changes of more recent versions are tracked at https://github.com/tox-dev/platformdirs/releases +The changes of more recent versions are `tracked here `_. platformdirs 4.0.0 (2023-11-10) -------------------------------