From bc4f525509db7797b6ff17b9d3c07326d4e10ce6 Mon Sep 17 00:00:00 2001 From: Tieqiong Zhang Date: Thu, 7 Aug 2025 23:44:00 -0500 Subject: [PATCH 1/4] fix readme indentation for pypi rendering --- README.rst | 12 ++++++------ news/readme.rst | 23 +++++++++++++++++++++++ 2 files changed, 29 insertions(+), 6 deletions(-) create mode 100644 news/readme.rst diff --git a/README.rst b/README.rst index edef84a..fb181eb 100644 --- a/README.rst +++ b/README.rst @@ -62,11 +62,11 @@ If you use diffpy.srfit in a scientific publication, we would like you to cite t and - V. Favre-Nicolin and R. Cerný - `FOX, 'free objects for crystallography': a modular approach to ab initio structure determination - from powder diffraction - `__, - *J. Appl. Cryst.* **35**, 734-743 (2002) + V. Favre-Nicolin and R. Cerný, + `FOX, 'free objects for crystallography': a modular approach to + ab initio structure determination from powder diffraction + `__, + *J. Appl. Cryst.* **35**, 734-743 (2002) The second paper describes the c++ crystallographic objects in ``ObjCryst++`` that are wrapped by ``pyobjcryst`` @@ -123,7 +123,7 @@ displayed in a jupyter notebook: Getting Started --------------- -You may consult our `online documentation `_ for tutorials and API references. +You may consult our `online documentation `_ for tutorials and API references. Alternative methods of installation ----------------------------------- diff --git a/news/readme.rst b/news/readme.rst new file mode 100644 index 0000000..a6eb8d8 --- /dev/null +++ b/news/readme.rst @@ -0,0 +1,23 @@ +**Added:** + +* No news: correct readme indentation for pypi rendering. + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +* From 6f3e5e8386f05e34be7effcfe2c5dff755ffadb5 Mon Sep 17 00:00:00 2001 From: Tieqiong Zhang Date: Thu, 7 Aug 2025 23:44:30 -0500 Subject: [PATCH 2/4] Revert "update changelog" This reverts commit ce224f1bc21aacd282895bbf69a184d836f0f9aa. --- CHANGELOG.rst | 8 -------- news/fbv.rst | 23 +++++++++++++++++++++++ news/link-QPA.rst | 23 +++++++++++++++++++++++ news/remove-template.rst | 23 +++++++++++++++++++++++ news/rm-copied-notebook.rst | 23 +++++++++++++++++++++++ 5 files changed, 92 insertions(+), 8 deletions(-) create mode 100644 news/fbv.rst create mode 100644 news/link-QPA.rst create mode 100644 news/remove-template.rst create mode 100644 news/rm-copied-notebook.rst diff --git a/CHANGELOG.rst b/CHANGELOG.rst index e67ed90..cadd06b 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,14 +4,6 @@ Release notes .. current developments -2025.1.0 -===== - -**Removed:** - -* Removed fallback version handling in `src/pyobjcryst/version.py`. - - Version 2024.X.X ---------------- diff --git a/news/fbv.rst b/news/fbv.rst new file mode 100644 index 0000000..e002016 --- /dev/null +++ b/news/fbv.rst @@ -0,0 +1,23 @@ +**Added:** + +* + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* Removed fallback version handling in `src/pyobjcryst/version.py`. + +**Fixed:** + +* + +**Security:** + +* diff --git a/news/link-QPA.rst b/news/link-QPA.rst new file mode 100644 index 0000000..a505e37 --- /dev/null +++ b/news/link-QPA.rst @@ -0,0 +1,23 @@ +**Added:** + +* No news added: Trivial change to index.rst + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +* diff --git a/news/remove-template.rst b/news/remove-template.rst new file mode 100644 index 0000000..e94597b --- /dev/null +++ b/news/remove-template.rst @@ -0,0 +1,23 @@ +**Added:** + +* No news added: Remove the documentation template and add QPA notebook in documentation. + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +* diff --git a/news/rm-copied-notebook.rst b/news/rm-copied-notebook.rst new file mode 100644 index 0000000..cbf3562 --- /dev/null +++ b/news/rm-copied-notebook.rst @@ -0,0 +1,23 @@ +**Added:** + +* No news added: Remove the copied notebooks after building the documentation. + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +* From 285b387ecb3209f295ce5a5d6109995c11910374 Mon Sep 17 00:00:00 2001 From: Simon Billinge Date: Fri, 8 Aug 2025 04:59:51 -0400 Subject: [PATCH 3/4] scikit-package level 5 --- news/readme.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/news/readme.rst b/news/readme.rst index a6eb8d8..0cdfb40 100644 --- a/news/readme.rst +++ b/news/readme.rst @@ -1,6 +1,6 @@ **Added:** -* No news: correct readme indentation for pypi rendering. +* **Changed:** @@ -16,7 +16,7 @@ **Fixed:** -* +* Code brought up to scikit-package level 5 standards with automated release workflows **Security:** From ff7585a2adb912730b3905bbc9516a1c0178adc0 Mon Sep 17 00:00:00 2001 From: Simon Billinge Date: Fri, 8 Aug 2025 05:07:15 -0400 Subject: [PATCH 4/4] change 2024.x.x to2024.2.2 in changelog --- CHANGELOG.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index cadd06b..fa47baf 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,7 +4,7 @@ Release notes .. current developments -Version 2024.X.X +Version 2024.2.2 ---------------- Changes