Merge pull request #344 from cadenmyers13/news-and-misc

sbillinge · web-flow · commit 86e59be4ed7f · 2025-06-11T13:53:58.000-04:00
skpkg: misc config and other file changes
diff --git a/.codespell/ignore_words.txt b/.codespell/ignore_words.txt
@@ -4,8 +4,5 @@
 ;; abbreviation for "materials" often used in a journal title
 mater
 
-;; alternative use of socioeconomic
-socio-economic
-
 ;; Frobenius norm used in np.linalg.norm
 fro
diff --git a/.flake8 b/.flake8
@@ -1,3 +1,5 @@
+# As of now, flake8 does not natively support configuration via pyproject.toml
+# https://github.com/microsoft/vscode-flake8/issues/135
 [flake8]
 exclude =
     .git,
diff --git a/.isort.cfg b/.isort.cfg
@@ -1,4 +1,5 @@
 [settings]
+# Keep import statement below line_length character limit
 line_length = 79
 multi_line_output = 3
 include_trailing_comma = True
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "latest"
+
+python:
+  install:
+    - requirements: requirements/docs.txt
+
+sphinx:
+  configuration: doc/source/conf.py
diff --git a/environment.yml b/environment.yml
diff --git a/news/news-and-misc.rst b/news/news-and-misc.rst
@@ -0,0 +1,23 @@
+**Added:**
+
+* No news item needed, bringing package up to ``scikit-package 5v0.1.0`` standards.
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>
diff --git a/pyproject.toml b/pyproject.toml
@@ -6,13 +6,13 @@ build-backend = "setuptools.build_meta"
 name = "diffpy.utils"
 dynamic=['version', 'dependencies']
 authors = [
-  { name="Simon J.L. Billinge group", email="simon.billinge@gmail.com" },
+  { name="Simon Billinge", email="sb2896@columbia.edu" },
 ]
 maintainers = [
-  { name="Simon J.L. Billinge group", email="simon.billinge@gmail.com" },
+  { name="Simon Billinge", email="sb2896@columbia.edu" },
 ]
 description = "General utilities for analyzing diffraction data"
-keywords = ["text data parsers", "wx grid", "diffraction objects"]
+keywords = ['text data parsers', 'wx grid', 'diffraction objects']
 readme = "README.rst"
 requires-python = ">=3.11, <3.14"
 classifiers = [
@@ -27,7 +27,7 @@ classifiers = [
         'Operating System :: Unix',
         'Programming Language :: Python :: 3.11',
         'Programming Language :: Python :: 3.12',
-	'Programming Language :: Python :: 3.13',
+        'Programming Language :: Python :: 3.13',
         'Topic :: Scientific/Engineering :: Physics',
         'Topic :: Scientific/Engineering :: Chemistry',
 ]
diff --git a/requirements/docs.txt b/requirements/docs.txt
@@ -2,3 +2,4 @@ sphinx
 sphinx_rtd_theme
 doctr
 m2r
+sphinx-copybutton

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# As of now, flake8 does not natively support configuration via pyproject.toml`
	`2`	`+# https://github.com/microsoft/vscode-flake8/issues/135`
`1`	`3`	`[flake8]`
`2`	`4`	`exclude =`
`3`	`5`	`.git,`