Add deprecation notice to the docs

sandialabs · Oct 24, 2023 · 9818e19 · 9818e19
1 parent 05e13e3
commit 9818e19
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,6 +24,10 @@ Updates and Changes
 ### Security
 -->
 
+## [0.8.1.5] - 2023-10-24
+### Changed
+- Add deprecation notice to the docs
+
 ## [0.8.1.4] - 2023-10-24
 ### Changed
 - Remove maintainer contact info

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -5,6 +5,31 @@
 
 ConfigParserEnhanced
 ====================
+
+.. admonition:: DEPRECATION NOTICE
+
+   This package was forked by the original author and subdivided into separate
+   packages:
+
+   * ``ConfigParserEnhanced`` ⟶ ``ActiveConfigParser``
+     (`GitLab <https://gitlab.com/semantik-software/code/python/ActiveConfigParser>`__,
+     `PyPI <https://pypi.org/project/activeconfigparser/>`__,
+     `Docs <https://semantik-software.gitlab.io/code/python/ActiveConfigParser/>`__)
+   * ``Debuggable`` ⟶ ``LightweightDebugMessages``
+     (`GitLab <https://gitlab.com/semantik-software/code/python/LightweightDebugMessages>`__,
+     `PyPI <https://pypi.org/project/lightweightdebugmessages/>`__,
+     `Docs <https://semantik-software.gitlab.io/code/python/LightweightDebugMessages>`__)
+   * ``ExceptionControl`` ⟶ ``ExceptionControl``
+     (`GitLab <https://gitlab.com/semantik-software/code/python/ExceptionControl>`__,
+     `PyPI <https://pypi.org/project/exceptioncontrol/>`__,
+     `Docs <https://semantik-software.gitlab.io/code/python/ExceptionControl>`__)
+   * ``TypedProperty`` ⟶ ``StronglyTypedProperty``
+     (`GitLab <https://gitlab.com/semantik-software/code/python/StronglyTypedProperty>`__,
+     `PyPI <https://pypi.org/project/stronglytypedproperty/>`__,
+     `Docs <https://semantik-software.gitlab.io/code/python/StronglyTypedProperty>`__)
+
+   Users of ``ConfigParserEnhanced`` should switch to the new packages.
+
 .. toctree::
    :maxdepth: 1
    :caption: Table of Contents:

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "configparserenhanced"
 description = "A tool that extends configparser to enable enhanced processing of .ini files."
-version = "0.8.1.4"
+version = "0.8.1.5"
 license = "LICENSE"
 readme = "README.md"
 keywords = [

diff --git a/src/configparserenhanced/version.py b/src/configparserenhanced/version.py
@@ -45,4 +45,4 @@
 
 # Note, when updating this, the docstring in ConfigParserEnhanced
 # and in pyproject.toml should also be updated
-__version__ = "0.8.1.4"
+__version__ = "0.8.1.5"