Skip to content

Commit c83de82

Browse files
committed
skpkg: change email in README and migrate diffpy.morph and index.rst
1 parent 9422c9e commit c83de82

File tree

3 files changed

+65
-12
lines changed

3 files changed

+65
-12
lines changed

README.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,9 @@ Enjoy!
164164
Support and Contribute
165165
----------------------
166166

167-
If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/diffpy.morph/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.morph/pulls>`_.
167+
`Diffpy user group <https://groups.google.com/g/diffpy-users>`_ is the discussion forum for general questions and discussions about the use of diffpy.morph. Please join the diffpy.morph users community by joining the Google group. The diffpy.morph project welcomes your expertise and enthusiasm!
168+
169+
If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/diffpy.morph/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.morph/pulls>`_. You can also post it to the `Diffpy user group <https://groups.google.com/g/diffpy-users>`_.
168170

169171
Feel free to fork the project and contribute. To install diffpy.morph
170172
in a development mode, with its sources being directly used by Python
@@ -192,7 +194,7 @@ Before contributing, please read our `Code of Conduct <https://github.com/diffpy
192194
Contact
193195
-------
194196

195-
For more information on diffpy.morph please visit the project `web-page <https://diffpy.github.io/>`_ or email Simon J.L. Billinge group at [email protected].
197+
For more information on diffpy.morph please visit the project `web-page <https://diffpy.github.io/>`_ or email Simon J.L. Billinge group at [email protected].
196198

197199
Acknowledgements
198200
----------------

doc/source/api/diffpy.morph.rst

Lines changed: 56 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
:tocdepth: -1
22

3-
|title|
4-
=======
5-
6-
.. |title| replace:: diffpy.morph package
3+
diffpy.morph package
4+
====================
75

86
.. automodule:: diffpy.morph
97
:members:
@@ -14,17 +12,66 @@ Subpackages
1412
-----------
1513

1614
.. toctree::
17-
diffpy.morph.example_package
15+
:titlesonly:
16+
17+
diffpy.morph.morphs
18+
diffpy.morph.morph_helpers
1819

1920
Submodules
2021
----------
2122

22-
|module|
23-
--------
23+
diffpy.morph.plot module
24+
^^^^^^^^^^^^^^^^^^^^^^^^
25+
26+
.. automodule:: diffpy.morph.plot
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
diffpy.morph.morph_api module
32+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33+
34+
.. automodule:: diffpy.morph.morph_api
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
diffpy.morph.refine module
40+
^^^^^^^^^^^^^^^^^^^^^^^^^^
41+
42+
.. automodule:: diffpy.morph.refine
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
diffpy.morph.tools module
48+
^^^^^^^^^^^^^^^^^^^^^^^^^
49+
50+
.. automodule:: diffpy.morph.tools
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
diffpy.morph.morph_io module
56+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
57+
58+
.. automodule:: diffpy.morph.morph_io
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
diffpy.morph.log module
64+
^^^^^^^^^^^^^^^^^^^^^^^
65+
66+
.. automodule:: diffpy.morph.log
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
2470

25-
.. |module| replace:: diffpy.morph.example_submodule module
71+
diffpy.morph.morphapp module
72+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2673

27-
.. automodule:: diffpy.morph.example_submodule
74+
.. automodule:: diffpy.morph.morphapp
2875
:members:
2976
:undoc-members:
3077
:show-inheritance:

doc/source/index.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,11 @@ To get started, please visit the :ref:`Getting started <getting-started>` page.
2121
Authors
2222
=======
2323

24-
``diffpy.morph`` is developed by Sangjoon Lee, Simon Billinge, Billinge Group members. The maintainer for this project is Simon J.L. Billinge group. For a detailed list of contributors see
24+
``diffpy.morph`` is developed by members of the Billinge Group at
25+
Columbia University and Brookhaven National Laboratory including
26+
Christopher L. Farrow, Christopher J. Wright, Pavol Juhás, Chia-Hao
27+
(Timothy) Liu, Andrew Yang, and Simon J. L. Billinge.
28+
For a detailed list of contributors, see
2529
https://github.com/diffpy/diffpy.morph/graphs/contributors.
2630

2731
============

0 commit comments

Comments
 (0)