Skip to content

Commit fa180cb

Browse files
authored
Merge pull request #97 from cadenmyers13/add-ex
doc: Add nanoparticle example
2 parents f8c6f32 + 1cb979b commit fa180cb

File tree

3 files changed

+25
-1
lines changed

3 files changed

+25
-1
lines changed

.github/ISSUE_TEMPLATE/release_checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ assignees: ""
99
### checklist for diffpy.cmi
1010

1111
- [ ] Manually trigger the `validate-examples.yml` workflow to run all example scripts.
12-
- [ ] Make sure available examples, packs, and profiles are listed in the docs. Check this by installing locally with `pip install .`, building the docs with `cmi install docs && cd docs && make html && open build/html/index.html`, running `cmi info`, and comparing the output to what is listed under "Examples" in the docs.
12+
- [ ] Make sure available examples, packs, and profiles are listed in the docs. Check this by installing locally with `pip install .`, building the docs with `cmi install docs && cd docs && make html && open build/html/index.html`, running `cmi info`, and comparing the output to what is listed in the docs.
1313

1414
### PyPI/GitHub rc-release preparation checklist:
1515

docs/source/tutorials/pdf.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Available Examples
1212
- ch07StructuralPhaseTransitions
1313
- ch08NPRefinement
1414
- ch11ClusterXYZ
15+
- nanoparticle-fit
1516

1617
Ni PDF Fitting Tutorial
1718
-----------------------

news/add-ex.rst

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

0 commit comments

Comments
 (0)