skpkg: migrate documentation and rst files

[cadenmyers13]

I added autodoc_mock_imports = ["diffpy.pdffit2.pdffit2",] to conf.py due to a circular import error in src/pdffit2/__init__.py and src/pdffit2/pdffit.py. Without this, the package API does not render. This could be fixed with a "lazy import" in pdffit.py, but that seems way more involved and i dont want to break anything.

[cadenmyers13]

Needed to be extended to docs could render properly

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.97%. Comparing base (74add76) to head (6915dc8).
Report is 3 commits behind head on migration.

Additional details and impacted files

@@            Coverage Diff             @@
##           migration     #137   +/-   ##
==========================================
  Coverage      98.97%   98.97%           
==========================================
  Files              6        6           
  Lines           1267     1267           
==========================================
  Hits            1254     1254           
  Misses            13       13           

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[cadenmyers13]

@sbillinge ready for review

[sbillinge]

please see comments. Please could you harvest anything that needs to be put into anothee issue too? Thx

[sbillinge]

pretty sure it is not BSD-3 but please check. I need you to be a bit more careful here. The license is a legal thing and we don't want to get it wrong, so please pay close attention.

[sbillinge]

also a bit nervous about unilaterally changing the license here. It looks as if it is only a change from bullet list to enumerated list, but still. This is another argument for package update public, that it doesn't create a new license file.

[sbillinge]

same here....no changes to licenses...

[cadenmyers13]

@sbillinge license is BSD License as per the pyproject.toml. Is this different that BSD-3?

from pyproject.toml:

        'License :: OSI Approved :: BSD License',

[cadenmyers13]

@sbillinge chatGPT thinks the license on main is a BSD-3 license (I tried not to bias it in the query):

it said this:

This license is a variant of the BSD 3-Clause License (permissive open-source). It allows redistribution and modification, with standard conditions:

• Must retain copyright.
• Must include the license text in binaries.
• Cannot use author/institution names to promote derived works without permission.

It also includes a non-binding request to cite a specific paper in scientific publications. The software is distributed as-is, without warranty.

This is a permissive license compatible with open-source and commercial use. ✅

[sbillinge]

yes, it is a variant of BSD-3, i.e., not BSD-3

[cadenmyers13]

closing this to redo