diff --git a/.gitignore b/.gitignore index cdd5137..2cc0161 100644 --- a/.gitignore +++ b/.gitignore @@ -62,4 +62,4 @@ setuptools-*.zip .pytest_cache .vscode/ result_images/ -docs/source/_dynamic/README.rst +docs/source/_dynamic/*.rst diff --git a/CHANGELOG.md b/CHANGELOG.md index d09b9b2..55da962 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,27 @@ -## Changelog of Scikit-Criteria +# Changelog of Scikit-Criteria -## 0.6 + + +## Version 0.6 + +- Support for Python 3.10. +- All the objects of the project are now immutable by design, and can only + be mutated troughs the `object.copy()` method. +- Dominance analysis tools (`DecisionMatrix.dominance`). +- The method `DecisionMatrix.describe()` was deprecated and will be removed + in version *1.0*. +- New statistics functionalities `DecisionMatrix.stats` accessor. +- The accessors are now cached in the `DecisionMatrix`. + +- Tutorial for dominance and satisfaction analysis. - TOPSIS now support hyper-parameters to select different metrics. +- Generalize the idea of accessors in scikit-criteria througth a common + framework (`skcriteria.utils.accabc` module). +- New deprecation mechanism through the +- `skcriteria.utils.decorators.deprecated` decorator. -## 0.5 +## Version 0.5 In this version scikit-criteria was rewritten from scratch. Among other things: @@ -17,10 +34,10 @@ In this version scikit-criteria was rewritten from scratch. Among other things: **Full Changelog**: https://github.com/quatrope/scikit-criteria/commits/0.5 -## 0.2 +## Version 0.2 First OO stable version. -## 0.1 +## Version 0.1 -Only functions. \ No newline at end of file +Only functions. diff --git a/MANIFEST.in b/MANIFEST.in index 7b822d6..0b06f18 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,11 +1,11 @@ include LICENSE include README.md +include CHANGELOG.md recursive-include skcriteria *.py exclude tox.ini exclude pyproject.toml -exclude CHANGELOG.md exclude .header-template exclude .readthedocs.yml diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst new file mode 100644 index 0000000..eb98771 --- /dev/null +++ b/docs/source/changelog.rst @@ -0,0 +1,4 @@ +Changelog +============ + +.. include:: _dynamic/CHANGELOG.rst \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 8eeb311..fd8a70e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -242,17 +242,22 @@ import m2r -with open(SKCRITERIA_PATH / "README.md") as fp: - readme_md = fp.read().split("")[-1] - +DYNAMIC_RST = { + "README.md": "README.rst", + "CHANGELOG.md": "CHANGELOG.rst", +} -README_RST_PATH = CURRENT_PATH / "_dynamic" / "README.rst" +for md_name, rst_name in DYNAMIC_RST.items(): + md_path = SKCRITERIA_PATH / md_name + with open(md_path) as fp: + readme_md = fp.read().split("")[-1] + rst_path = CURRENT_PATH / "_dynamic" / rst_name -with open(README_RST_PATH, "w") as fp: - fp.write(".. FILE AUTO GENERATED !! \n") - fp.write(m2r.convert(readme_md)) - print(f"{README_RST_PATH} regenerated!") + with open(rst_path, "w") as fp: + fp.write(".. FILE AUTO GENERATED !! \n") + fp.write(m2r.convert(readme_md)) + print(f"{md_path} -> {rst_path} regenerated!") # ============================================================================= diff --git a/docs/source/index.rst b/docs/source/index.rst index 4be4522..78520c2 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -39,6 +39,7 @@ Contents :maxdepth: 2 :caption: Misc + changelog bibliography diff --git a/skcriteria/__init__.py b/skcriteria/__init__.py index 73b78ba..d6f0f09 100644 --- a/skcriteria/__init__.py +++ b/skcriteria/__init__.py @@ -30,7 +30,7 @@ __all__ = ["mkdm", "DecisionMatrix", "Objective"] -__version__ = ("0", "6dev0") +__version__ = ("0", "6") NAME = "scikit-criteria"