From 488ad0f82764838a5d39f04c7e8619cd9f568e1b Mon Sep 17 00:00:00 2001 From: Myk Taylor Date: Sun, 6 Aug 2023 23:02:45 -0700 Subject: [PATCH] add changelog template for new verions and mark unused headers as deprecated --- docs/changelog.txt | 22 +++++++++++++++++++++- docs/sphinx_extensions/dfhack/changelog.py | 8 ++++---- 2 files changed, 25 insertions(+), 5 deletions(-) diff --git a/docs/changelog.txt b/docs/changelog.txt index 0559b2dde..eca35b2e8 100644 --- a/docs/changelog.txt +++ b/docs/changelog.txt @@ -22,6 +22,26 @@ changelog.txt uses a syntax similar to RST, with a few special sequences: spans multiple lines. Three ``]`` characters indicate the end of such a block. - ``!`` immediately before a phrase set up to be replaced (see gen_changelog.py) stops that occurrence from being replaced. +Template for new versions: + +# Future + +## New Features + +## Fixes + +## Misc Improvements + +## Documentation + +## API + +## Internals + +## Lua + +## Removed + ===end ]]] @@ -33,7 +53,7 @@ changelog.txt uses a syntax similar to RST, with a few special sequences: # Future -## New Plugins +## New Features ## Fixes diff --git a/docs/sphinx_extensions/dfhack/changelog.py b/docs/sphinx_extensions/dfhack/changelog.py index dd59fa9d5..cc309e425 100644 --- a/docs/sphinx_extensions/dfhack/changelog.py +++ b/docs/sphinx_extensions/dfhack/changelog.py @@ -16,11 +16,11 @@ CHANGELOG_PATHS = ( CHANGELOG_PATHS = (os.path.join(DFHACK_ROOT, p) for p in CHANGELOG_PATHS) CHANGELOG_SECTIONS = [ - 'New Plugins', - 'New Scripts', - 'New Tweaks', + 'New Plugins', # deprecated + 'New Scripts', # deprecated + 'New Tweaks', # deprecated 'New Features', - 'New Internal Commands', + 'New Internal Commands', # deprecated 'Fixes', 'Misc Improvements', 'Removed',