diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index 873b0eb..8ac087b 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -9,7 +9,7 @@ assignees: "" ### checklist for diffpy.cmi - [ ] Manually trigger the `validate-examples.yml` workflow to run all example scripts. -- [ ] 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. +- [ ] 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. ### PyPI/GitHub rc-release preparation checklist: diff --git a/docs/source/tutorials/pdf.rst b/docs/source/tutorials/pdf.rst index d12046e..52ad280 100644 --- a/docs/source/tutorials/pdf.rst +++ b/docs/source/tutorials/pdf.rst @@ -12,6 +12,7 @@ Available Examples - ch07StructuralPhaseTransitions - ch08NPRefinement - ch11ClusterXYZ +- nanoparticle-fit Ni PDF Fitting Tutorial ----------------------- diff --git a/news/add-ex.rst b/news/add-ex.rst new file mode 100644 index 0000000..ffd90cb --- /dev/null +++ b/news/add-ex.rst @@ -0,0 +1,23 @@ +**Added:** + +* No news needed, add example to list in docs. + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*