Merge pull request #61 from bobleesj/api-workflow

API workflow: generate API module, remove older README,

Author: sbillinge

LICENSE

@@ -1,30 +1,68 @@
 :tocdepth: -1
 
-|title|
-=======
-
-.. |title| replace:: diffpy.snmf package
+diffpy.snmf package
+===================
 
 .. automodule:: diffpy.snmf
     :members:
     :undoc-members:
     :show-inheritance:
 
-Subpackages
------------
-
-.. toctree::
-   diffpy.snmf.example_package
-
 Submodules
 ----------
 
-|module|
---------
+diffpy.snmf.subroutines module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: diffpy.snmf.subroutines
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+diffpy.snmf.containers module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: diffpy.snmf.containers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+diffpy.snmf.io module
+^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: diffpy.snmf.io
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+diffpy.snmf.polynomials module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: diffpy.snmf.polynomials
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+diffpy.snmf.optimizers module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: diffpy.snmf.optimizers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+diffpy.snmf.factorizers module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: diffpy.snmf.factorizers
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
-.. |module| replace:: diffpy.snmf.example_submodule module
+diffpy.snmf.stretchednmfapp module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. automodule:: diffpy.snmf.example_submodule
+.. automodule:: diffpy.snmf.stretchednmfapp
     :members:
     :undoc-members:
     :show-inheritance:

README.md

@@ -66,6 +66,7 @@ To get started, please go to :ref:`quick_start`
 
    license
    release
+   Package API <api/diffpy.snmf>
 
 .. include:: ../../CHANGELOG.rst
 

doc/source/api/diffpy.snmf.example_package.rst

@@ -1,3 +1,53 @@
+[build-system]
+requires = ["setuptools>=62.0", "setuptools-git-versioning<2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "diffpy.snmf"
+dynamic=['version']
+authors = [
+  { name="Simon J.L. Billinge group", email="simon.billinge@gmail.com" },
+]
+maintainers = [
+  { name="Simon J.L. Billinge group", email="simon.billinge@gmail.com" },
+]
+description = "A python package implementing the stretched NMF algorithm."
+keywords = ['diffpy', 'PDF']
+readme = "README.rst"
+requires-python = ">=3.10"
+classifiers = [
+        'Development Status :: 5 - Production/Stable',
+        'Environment :: Console',
+        'Intended Audience :: Developers',
+        'Intended Audience :: Science/Research',
+        'License :: OSI Approved :: BSD License',
+        'Operating System :: MacOS :: MacOS X',
+        'Operating System :: Microsoft :: Windows',
+        'Operating System :: POSIX',
+        'Operating System :: Unix',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12',
+        'Topic :: Scientific/Engineering :: Physics',
+        'Topic :: Scientific/Engineering :: Chemistry',
+]
+
+[project.urls]
+Homepage = "https://github.com/diffpy/diffpy.snmf/"
+Issues = "https://github.com/diffpy/diffpy.snmf/issues/"
+
+[tool.setuptools-git-versioning]
+enabled = true
+template = "{tag}"
+dev_template = "{tag}"
+dirty_template = "{tag}"
+
+[tool.setuptools.packages.find]
+where = ["src"]  # list of folders that contain the packages (["."] by default)
+include = ["*"]  # package names should match these glob patterns (["*"] by default)
+exclude = ["diffpy.snmf.tests*"]  # exclude packages matching these glob patterns (empty by default)
+namespaces = false  # to disable scanning PEP 420 namespaces (true by default)
+
 [tool.black]
 line-length = 115
 include = '\.pyi?$'