Merge pull request #204 from zmx27/doc

skpkg: migrate documentation, README, and public static files

Author: sbillinge

AUTHORS.rst

@@ -1,5 +1,5 @@
 Authors
-========
+=======
 
 Billinge Group and community contributors.
 

CHANGELOG.rst

@@ -1,5 +1,5 @@
 =============
-Release Notes
+Release notes
 =============
 
 .. current developments

CODE_OF_CONDUCT.rst

@@ -8,7 +8,7 @@ Our Pledge
 We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
 size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
+identity and expression, level of experience, education, socioeconomic status,
 nationality, personal appearance, race, caste, color, religion, or sexual
 identity and orientation.
 

LICENSE.rst

@@ -1,7 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2024, The Trustees of Columbia University
-in the City of New York.
+Copyright (c) 2024-2025, The Trustees of Columbia University in the City of New York.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.rst

@@ -1,11 +1,14 @@
-|Icon| `diffpy.morph <https://diffpy.github.io/diffpy.morph>`_
-==============================================================
+|Icon| |title|_
+===============
+
+.. |title| replace:: diffpy.morph
+.. _title: https://diffpy.github.io/diffpy.morph
 
 .. |Icon| image:: https://avatars.githubusercontent.com/diffpy
         :target: https://diffpy.github.io/diffpy.morph
         :height: 100px
 
-|PyPi| |Forge| |PythonVersion| |PR|
+|PyPI| |Forge| |PythonVersion| |PR|
 
 |CI| |Codecov| |Black| |Tracking|
 
@@ -23,7 +26,7 @@
 
 .. |PR| image:: https://img.shields.io/badge/PR-Welcome-29ab47ff
 
-.. |PyPi| image:: https://img.shields.io/pypi/v/diffpy.morph
+.. |PyPI| image:: https://img.shields.io/pypi/v/diffpy.morph
         :target: https://pypi.org/project/diffpy.morph/
 
 .. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/diffpy.morph
@@ -32,7 +35,7 @@
 .. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
         :target: https://github.com/diffpy/diffpy.morph/issues
 
-Tools for manipulating and comparing PDF profiles
+Python package for manipulating and comparing PDF profiles
 
 ``diffpy.morph`` is a Python software package designed to increase the insight
 researchers can obtain from measured atomic pair distribution functions
@@ -107,11 +110,11 @@ The following creates and activates a new environment named ``diffpy.morph_env``
         conda create -n diffpy.morph_env diffpy.morph
         conda activate diffpy.morph_env
 
-To confirm that the installation was successful, type::
+To confirm that the installation was successful, type ::
 
         python -c "import diffpy.morph; print(diffpy.morph.__version__)"
 
-        The output should print the latest version displayed on the badges above.
+The output should print the latest version displayed on the badges above.
 
 If the above does not work, you can use ``pip`` to download and install the latest release from
 `Python Package Index <https://pypi.python.org>`_.
@@ -174,7 +177,7 @@ in a development mode, with its sources being directly used by Python
 rather than copied to a package directory, use the following in the root
 directory ::
 
-	pip install -e .
+        pip install -e .
 
 To ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit
 hooks.
@@ -195,4 +198,9 @@ Before contributing, please read our `Code of Conduct <https://github.com/diffpy
 Contact
 -------
 
-For more information on diffpy.morph please visit the project `web-page <https://diffpy.github.io/>`_ or email Prof. Simon Billinge at sb2896@columbia.edu.
+For more information on diffpy.morph please visit the project `web-page <https://diffpy.github.io/>`_ or email Simon J.L. Billinge group at sb2896@columbia.edu.
+
+Acknowledgements
+----------------
+
+``diffpy.morph`` is built and maintained with `scikit-package <https://scikit-package.github.io/scikit-package/>`_.