chore: update documentation website

CHANGELOG.md

@@ -1,71 +1,73 @@
-# Version 4.1.0
+# Changelog
+
+## Version 4.1.0
 
 - Do not store cached hash value when pickling. Thanks to [@matthiasdiener](https://github.com/matthiasdiener) for the [PR #287](https://github.com/corenting/immutabledict/pull/287)
 
-# Version 4.0.0
+## Version 4.0.0
 
 - Replace `__init__` by `__new__`. Thanks to [@spacether](https://github.com/spacether) for the [PR #263](https://github.com/corenting/immutabledict/pull/263)
 - Add explicit items()/keys()/values() methods to speedup these methods. Thanks to [@matthiasdiener](https://github.com/matthiasdiener) for the [PR #265](https://github.com/corenting/immutabledict/pull/265)
 - Add set/delete/update functions. Thanks to [@matthiasdiener](https://github.com/matthiasdiener) for the [PR #271](https://github.com/corenting/immutabledict/pull/271)
 - Add documentation at [immutabledict.corenting.fr](https://immutabledict.corenting.fr)
 
-# Version 3.0.0
+## Version 3.0.0
 
 - `copy()` (**breaking change**): remove the option to pass keyword arguments (which were present as key/value pairs in the copy). Now the method doesn't take any arguments (it behaves the same as a normal `dict`).
 - Python versions: drop Python 3.7 support
 - Typing: fixes
   - Make the key covariant. Thanks to [@spacether](https://github.com/spacether) for the [PR #244](https://github.com/corenting/immutabledict/pull/244)
   - Fix key/value typing missing for ImmutableOrderedDict
 
-# Version 2.2.5
+## Version 2.2.5
 
 - Fix hard-coded class reference in fromkeys() resulting in always using `dict` for `fromkeys()` (instead of OrderedDict in ImmutableOrderedDict for example). Thanks to [@cthoyt](https://github.com/cthoyt) for the [PR #234](https://github.com/corenting/immutabledict/pull/234)
 
-# Version 2.2.4
+## Version 2.2.4
 
 - Include tests in sdist for easier packaging
 
-# Version 2.2.3
+## Version 2.2.3
 
 - Fix TypeError message when using `|=`. Thanks to [@ronshapiro](https://github.com/ronshapiro) for the [PR #66](https://github.com/corenting/immutabledict/pull/66)
 - Update docstring for ImmutableOrderedDict to indicate that is not needed anymore for Python >= 3.7 but kept for compatibility purposes
 - Use postponed evaluation of annotations ([PEP 563](https://peps.python.org/pep-0563/)) for the typing
 
-# Version 2.2.2
+## Version 2.2.2
 
 - Update classifiers, Github Actions... for Python 3.11 (no code changes)
 
-# Version 2.2.1
+## Version 2.2.1
 
 - Update classifiers, Github Actions... for Python 3.10 (no code changes)
 
-# Version 2.2.0
+## Version 2.2.0
 
 - Use `poetry-core` instead of poetry for build-system. Thanks to [@mweinelt](https://github.com/mweinelt) for reporting [the issue](https://github.com/corenting/immutabledict/issues/56).
 
-# Version 2.1.0
+## Version 2.1.0
 
 - Fix type annotation on keyword argument in copy(**add_or_replace). Thanks to [@techsy730](https://github.com/techsy730) for the [PR #54](https://github.com/corenting/immutabledict/pull/54).
 
-# Version 2.0.0
+## Version 2.0.0
 
 - Support more typing (fix [issue #47](https://github.com/corenting/immutabledict/issues/47))
 - ⚠️ Remove `*args, **kwargs` from the `fromkeys()` method.
 
-# Version 1.3.0
+## Version 1.3.0
 
 - Add typing. Thanks to [@aecay](https://github.com/aecay) for the [PR #45](https://github.com/corenting/immutabledict/pull/45).
 
-# Version 1.2.0
+## Version 1.2.0
 
 - Support [PEP 584 union operators](https://www.python.org/dev/peps/pep-0584/). Thanks to [@lambdalisue](https://github.com/lambdalisue) for the [PR #34](https://github.com/corenting/immutabledict/pull/34).
 
-# Version 1.1.0
+## Version 1.1.0
 
 - Add Python 3.9 to supported versions, remove Python 3.5
 - Bump dev dependencies
 - Improve README
 
-# Version 1.0.0
+## Version 1.0.0
 
 - Initial stable release

Makefile

@@ -14,3 +14,7 @@ style:
 .PHONY: test
 test:
 	$(PYTHON) pytest tests --cov=immutabledict --cov-report=xml
+
+.PHONY: build-doc
+build-doc:
+	$(PYTHON) sphinx-build -M html docs docs/build

docs/changelog.rst

@@ -0,0 +1,2 @@
+.. include:: ../CHANGELOG.md
+   :parser: myst_parser.sphinx_

docs/conf.py

@@ -13,6 +13,7 @@
     "alabaster",
     "sphinx.ext.intersphinx",
     "sphinx.ext.autodoc",
+    "myst_parser",
 ]
 
 templates_path = ["_templates"]

docs/index.rst

@@ -1,7 +1,7 @@
 Welcome to immutabledict’s documentation!
 =========================================
 
-This site covers immutabledict’s API documentation. For more information about immutabledict, see `the Github repository <https://github.com/corenting/immutabledict>`_.
+This site covers immutabledict’s API documentation for version |release|. For more information about immutabledict, see `the Github repository <https://github.com/corenting/immutabledict>`_.
 
 Usage
 -----
@@ -28,4 +28,5 @@ API reference
 
    /api/immutabledict
    /api/immutable_ordered_dict
+   changelog
 

pyproject.toml

@@ -27,6 +27,7 @@ python = "^3.8"
 [tool.poetry.dev-dependencies]
 coverage = "*"
 mypy = "*"
+myst-parser = { version = "^2.0.0", python = "^3.9" }
 pytest = "*"
 pytest-cov = "*"
 ruff = "*"