Skip to content

Commit 9ba2f43

Browse files
authored
Remove manual and update README (#218)
* Remove manual and update README * News
1 parent f22b5f5 commit 9ba2f43

File tree

5 files changed

+32
-7
lines changed

5 files changed

+32
-7
lines changed

README.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ and typing into a terminal window or Windows command prompt. It is
8282
recommended that you consult online resources and become somewhat
8383
familiar before using ``diffpy.morph``.
8484

85-
``diffpy.morph`` can be run with Python 3.10 or higher. It makes use of several third party
85+
``diffpy.morph`` can be run with Python 3.11 or higher. It makes use of several third party
8686
libraries that you'll need to run the app and its components.
8787

8888
* `NumPy` - library for scientific computing with Python
@@ -140,8 +140,7 @@ You may consult our `online documentation <https://diffpy.github.io/diffpy.morph
140140
USING diffpy.morph
141141
------------------
142142

143-
For detailed instructions and full tutorial, consult the user manual
144-
on our `website <www.diffpy.org/diffpy.morph/>`.
143+
For detailed instructions and full tutorial, see our `website <www.diffpy.org/diffpy.morph/>`.
145144

146145
Once the required software, including ``diffpy.morph`` is all installed, open
147146
up a terminal and check installation has worked properly by running ::
@@ -158,9 +157,8 @@ of ``diffpy.morph`` that you have installed on your system. To begin using
158157

159158
where both PDFs file are text files which contain PDF data, such as ``.gr``
160159
or ``.cgr`` files that are produced by ``PDFgetX2``, ``PDFgetX3``,
161-
or ``PDFgui``. Though some file extensions other than ``.gr`` or ``.cgr``,
162-
but with the same content structure, have been shown to work with
163-
``diffpy.morph``, it is recommended to stick with ``.gr`` files.
160+
or ``PDFgui``. File extensions other than ``.gr`` or ``.cgr``,
161+
but with the same content structure, also work with ``diffpy.morph``.
164162

165163
Enjoy!
166164

doc/manual/README.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
This directory included files to build a PDF and HTML version of the diffpy.morph user manual.
2+
We are no longer maintaining the manual or this directory, but all files are intact for legacy reasons.
3+
All relevant information from the manual has been migrated to the website at https://www.diffpy.org/diffpy.morph.

news/v2_doc_fix.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
**Added:**
2+
3+
* <news item>
4+
5+
**Changed:**
6+
7+
* <news item>
8+
9+
**Deprecated:**
10+
11+
* <news item>
12+
13+
**Removed:**
14+
15+
* diffpy.morph manual removed.
16+
17+
**Fixed:**
18+
19+
* <news item>
20+
21+
**Security:**
22+
23+
* <news item>

src/diffpy/morph/morphapp.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,8 @@ def custom_error(self, msg):
402402
"as follows: each target PDF is an entry in NAMESFILE. For each "
403403
"entry, there should be a key {__save_morph_as__} whose value "
404404
"specifies the name to save the manipulated PDF as. An example "
405-
".json serial file is shown in the diffpy.morph manual."
405+
".json serial file is included in the tutorial directory "
406+
"on the package GitHub repository."
406407
),
407408
)
408409
group.add_option(

tutorial/diffpy.morph_manual.pdf

-772 KB
Binary file not shown.

0 commit comments

Comments
 (0)