docs(Changelog): moving to markdown format consistently

BAMresearch · Mar 23, 2023 · 083d67e · 083d67e
1 parent dc17e0a
commit 083d67e
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,15 @@ Changelog
 
 % <!--next-version-placeholder-->
 
+## v1.0.2 (2023-03-21)
+### Fix
+* **Documentation:** Case-sensitive GitHub Pages URL (2) ([`42352dc`](https://github.com/BAMresearch/McSAS3/commit/42352dc7031c6cf0828db921e1b770969b29fa00))
+* **Documentation:** Case-sensitive GitHub Pages URL ([`c7ba4b6`](https://github.com/BAMresearch/McSAS3/commit/c7ba4b676581cfeb55276d1e724141fbcc1c916c))
+
+### Documentation
+* **changelog:** Fix rendering by using myst_parser for markdown ([`2203914`](https://github.com/BAMresearch/McSAS3/commit/2203914b0b7191016e6bdc2591286eac4c7f54b3))
+* **General:** Fix parameters documentation format ([`b680822`](https://github.com/BAMresearch/McSAS3/commit/b6808225a60312ac3e500c2b46580efdca54a4e8))
+
 ## v1.0.1 (2023-03-20)
 ### Fix
 * **Notebook:** Platform independent fixed with fontname ([`64fd823`](https://github.com/BAMresearch/McSAS3/commit/64fd8232f6e6552bf2fcd74e01387c850bdde894))
@@ -16,8 +25,7 @@ Changelog
 * **notebook:** How to install missing packages ([`222197a`](https://github.com/BAMresearch/McSAS3/commit/222197ab29335b6a9c0e239cb8ed99120c2ea851))
 
 
-1.0.0 (2023-01-04)
-------------------
+## 1.0.0 (2023-01-04)
 
 * First release
 * Functional, thoroughly tested, no major bugs appear to remain.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -70,7 +70,7 @@ For merging, you should:
 
 1. Include passing tests (run ``tox``).
 2. Update documentation when there's new API, functionality etc.
-3. Add a note to ``CHANGELOG.rst`` about the changes.
+3. Add a note to ``CHANGELOG.md`` about the changes.
 4. Add yourself to ``AUTHORS.rst``.
 
 Tips

diff --git a/pyproject.toml b/pyproject.toml
@@ -47,7 +47,7 @@ include = ["mcsas3*"]
 
 [tool.setuptools.dynamic]
 version = {attr = "mcsas3.__version__"}
-readme = {file = ["README.rst", "CHANGELOG.rst"]}
+readme = {file = ["README.rst", "CHANGELOG.md"]}
 
 [tool.coverage.report]
 path = "coverage-report"
@@ -67,7 +67,7 @@ version_pattern = [
 version_source = "tag"
 prerelease_tag = "dev"
 branch = "main"                             # branch to make releases of
-changelog_file = "CHANGELOG.rst"            # changelog file
+changelog_file = "CHANGELOG.md"             # changelog file
 build_command = "python3 -m build"          # build dists
 upload_to_release = false                   # auto-create GitHub release
 upload_to_pypi = false                      # don't auto-upload to PyPI