Merge pull request #75 from Tieqiong/readme

sbillinge · web-flow · commit 7b55bd972be2 · 2025-08-08T05:07:30.000-04:00
fix readme indentation for pypi rendering
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -4,15 +4,7 @@ Release notes
 
 .. current developments
 
-2025.1.0
-=====
-
-**Removed:**
-
-* Removed fallback version handling in `src/pyobjcryst/version.py`.
-
-
-Version 2024.X.X
+Version 2024.2.2
 ----------------
 
 Changes
diff --git 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
-    <https://doi.org/10.1107/S0021889802015236>`__,
-    *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
+   <https://doi.org/10.1107/S0021889802015236>`__,
+   *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 <https://pyobjcryst.readthedocs.io/en/stable/>`_ for tutorials and API references.
+You may consult our `online documentation <https://diffpy.github.io/pyobjcryst>`_ for tutorials and API references.
 
 Alternative methods of installation
 -----------------------------------
diff --git a/news/fbv.rst b/news/fbv.rst
@@ -0,0 +1,23 @@
+**Added:**
+
+* <news item>
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* Removed fallback version handling in `src/pyobjcryst/version.py`.
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>
diff --git a/news/link-QPA.rst b/news/link-QPA.rst
@@ -0,0 +1,23 @@
+**Added:**
+
+* No news added: Trivial change to index.rst
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>
diff --git a/news/readme.rst b/news/readme.rst
@@ -0,0 +1,23 @@
+**Added:**
+
+* <news item>
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* Code brought up to scikit-package level 5 standards with automated release workflows
+
+**Security:**
+
+* <news item>
diff --git a/news/remove-template.rst b/news/remove-template.rst
@@ -0,0 +1,23 @@
+**Added:**
+
+* No news added: Remove the documentation template and add QPA notebook in documentation.
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>
diff --git a/news/rm-copied-notebook.rst b/news/rm-copied-notebook.rst
@@ -0,0 +1,23 @@
+**Added:**
+
+* No news added: Remove the copied notebooks after building the documentation.
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>
