skpkg: migrate documentation, README, and public static files #27

stevenhua0320 · 2025-10-06T02:34:24Z

@zmx27 ready for first round review
I need to do: check build doc after PR #24 merged,
do conda install --file requirements/docs.txt
cd docs && make html && open build/html/index.html
and commit the message
git add docs
git commit -m "skpkg: migrate documentation"

zmx27

See comments

zmx27 · 2025-10-07T06:38:43Z

AUTHORS.rst

+
+Xiaohao Yang
+
+Rundong Hua, Simon Billinge, Billinge Group members


I think just Billinge Group members (keep Xiaohao though)

zmx27 · 2025-10-07T06:41:29Z

LICENSE.rst

@@ -0,0 +1,41 @@
+BSD 3-Clause License


I think we should just keep the contents of the old LICENSENOTICE.txt file, update it to .rst, and change the copyright years so it ends at our current year

zmx27 · 2025-10-07T06:43:09Z

README.rst

+
+|PyPI| |Forge| |PythonVersion| |PR|
+
+|CI| |Codecov| |Black| |Tracking|


I don't think we need the PyPI, Forge, CI, Codecov badges. They don't apply to this repo

zmx27 · 2025-10-07T06:44:49Z

README.rst

+Citation
+--------
+
+If you use diffpy.srxplanargui in a scientific publication, we would like you to cite this package as


I believe this should refer to the xpdfsuite paper written by Professor Simon

zmx27 · 2025-10-07T06:45:49Z

README.rst

+        diffpy.srxplanargui Package, https://github.com/diffpy/diffpy.srxplanargui
+
+Installation
+------------


Conda forge will not be how we install this package. This package will likely be installed with xpdfsuite or perhaps as a wheel file if we decide to do it that way. And of course, users can always install from sources

So, since it would not be released on conda and pypi, we probably don't need the pypi installation instruction either?

zmx27 · 2025-10-07T06:46:36Z

README.rst

+---------------
+
+You may consult our `online documentation <https://diffpy.github.io/diffpy.srxplanargui>`_ for tutorials and API references.
+


I don't think we will have an online documentation for this package

zmx27 · 2025-10-07T06:46:53Z

README.rst

+You may consult our `online documentation <https://diffpy.github.io/diffpy.srxplanargui>`_ for tutorials and API references.
+
+Support and Contribute
+----------------------


I don't think this package will be open source

zmx27 · 2025-10-07T06:48:46Z

docs/source/index.rst

@@ -0,0 +1,56 @@
+#######


I don't think that we will be making docs for this, but please check with Professor Simon.

zmx27 · 2025-10-07T06:55:46Z

news/doc.rst

+
+**Fixed:**
+
+* Support ``scikit-package`` Level 5 standard (https://scikit-package.github.io/scikit-package/).


I think also add how you did py2 to py3 conversion in this news file

stevenhua0320 · 2025-10-07T15:13:01Z

@zmx27 Ready for review for edited files (no doc index.rst edit yet, please review for the other files)

zmx27

See comments. I don't think we will be needing the docs folder for this package as it's likely intended to be very lightweight, but do check with Professor Simon like I've said

zmx27 · 2025-10-07T19:48:49Z

LICENSE.rst

+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Use of this software is subject to and permitted only under a separate,


I think we just need this part, along with the copyright years being 2009-2025. I believe that the BSD license is used for open source projects, which doesn't apply here. We usually don't want to change the license of our packages. Since LICENSENOTICE.txt already exists, maybe just modify that file and change the copyright dates

zmx27 · 2025-10-07T19:51:15Z

README.rst

+.. |Codecov| image:: https://codecov.io/gh/diffpy/diffpy.srxplanargui/branch/main/graph/badge.svg
+        :target: https://codecov.io/gh/diffpy/diffpy.srxplanargui
+
+.. |Forge| image:: https://img.shields.io/conda/vn/conda-forge/diffpy.srxplanargui


You can probably delete the unused icon sections like |Forge|, etc. Also delete the CI icon, because it won't render properly on private repos

zmx27 · 2025-10-07T19:52:35Z

README.rst

+.. |PyPI| image:: https://img.shields.io/pypi/v/diffpy.srxplanargui
+        :target: https://pypi.org/project/diffpy.srxplanargui/
+
+.. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/diffpy.srxplanargui


This won't render properly since this package isn't on PyPI. I usually like to replace this with
|PythonVersion| image:: https://img.shields.io/badge/python-3.11%20|%203.12%20|%203.13-blue
to artificially generate the supported python versions (3.11-3.13)

zmx27 · 2025-10-07T19:53:41Z

README.rst


-REQUIREMENTS
------------------------------------------------------------------------
+For more information about the diffpy.srxplanargui library, please consult our `online documentation <https://diffpy.github.io/diffpy.srxplanargui>`_.


I don't think we will have an online documentation for this package

zmx27 · 2025-10-07T19:55:10Z

README.rst

+        diffpy.srxplanargui Package, https://github.com/diffpy/diffpy.srxplanargui
+
+Installation
+------------


zmx27 · 2025-10-07T19:55:50Z

README.rst

+Installation
+------------
+
+The preferred method is to be installed with ""xpdfsuite"" package or the wheel file.


Minor, but use `` to have it render as a "code" block

stevenhua0320 · 2025-10-07T21:05:31Z

@sbillinge Zhiming and I want to confirm that do we need documentation for this private package?

stevenhua0320 · 2025-10-07T21:40:48Z

@zmx27 Could you help me review if anywhere still needs edit for your comment files?

sbillinge · 2025-10-07T21:53:44Z

@stevenhua0320 I am merging this despite it failing tests as it contains no code. However, please can you make a PR with the objective of getting the tests to pass?

stevenhua0320 · 2025-10-07T21:58:38Z

@sbillinge I think we need to wait for the current open PR to be merged then we could have passing test. Since the .codespell and requirement folder are in current open PRs (different PRs). We need to merge those to have passing test.

stevenhua0320 added 5 commits October 5, 2025 22:16

skpkg: migrate docs/source files

06ca075

skpkg: add config files for authors, changelog, code of conduct, license

9a65970

skpkg: add MANIFEST.in

6c2dfba

skpkg: add README.rst

46ce44b

skpkg: add news files

9fcb544

zmx27 reviewed Oct 7, 2025

View reviewed changes

stevenhua0320 added 2 commits October 7, 2025 11:06

skpkg:change authors, license and readme to be correct

6c9922a

add news for py2 to py3 fix

fac04bb

zmx27 reviewed Oct 7, 2025

View reviewed changes

skpkg: change license and readme to correct private repo format

5c5a993

sbillinge merged commit 2fd5097 into diffpy:migration Oct 7, 2025
1 check failed

sbillinge deleted the doc branch October 7, 2025 21:53


		Xiaohao Yang

		Rundong Hua, Simon Billinge, Billinge Group members


		\|PyPI\| \|Forge\| \|PythonVersion\| \|PR\|

		\|CI\| \|Codecov\| \|Black\| \|Tracking\|

		---------------

		You may consult our `online documentation <https://diffpy.github.io/diffpy.srxplanargui>`_ for tutorials and API references.


		Fixed:

		* Support ``scikit-package`` Level 5 standard (https://scikit-package.github.io/scikit-package/).

skpkg: migrate documentation, README, and public static files #27

skpkg: migrate documentation, README, and public static files #27

Uh oh!

Conversation

stevenhua0320 commented Oct 6, 2025

Uh oh!

zmx27 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stevenhua0320 commented Oct 7, 2025

Uh oh!

zmx27 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stevenhua0320 commented Oct 7, 2025

Uh oh!

stevenhua0320 commented Oct 7, 2025

Uh oh!

Uh oh!

sbillinge commented Oct 7, 2025

Uh oh!

stevenhua0320 commented Oct 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants