Merge 278dcea into a1b38c2

pyxem · Sep 11, 2021 · 5f15d92 · 5f15d92
2 parents a1b38c2 + 278dcea
commit 5f15d92
Show file tree

Hide file tree

Showing 17 changed files with 848 additions and 811 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -21,5 +21,5 @@
 - [ ] The PR title is short, concise, and will make sense 1 year later.
 - [ ] New functions are imported in corresponding `__init__.py`.
 - [ ] New features, API changes, and deprecations are mentioned in the unreleased
-      section in `doc/changelog.rst`.
+      section in `CHANGELOG.rst`.
 - [ ] New contributors are added to .all-contributorsrc and the table is regenerated.
diff --git a/.github/workflows/perhaps_make_tagged_release_draft.py b/.github/workflows/perhaps_make_tagged_release_draft.py
@@ -37,7 +37,7 @@
     make_release = True
 
 if make_release:
-    with open("../../doc/changelog.rst", mode="r") as f:
+    with open("../../CHANGELOG.rst", mode="r") as f:
         content = f.readlines()
         changelog_start = 0
         changelog_end = 0

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,10 +1,11 @@
+include CHANGELOG.rst
 include kikuchipy/hyperspy_extension.yaml
 include LICENSE
 include MANIFEST.in
-include setup.cfg
 include README.md
-include RELEASE.rst
 include readthedocs.yml
+include RELEASE.rst
+include setup.cfg
 include setup.py
 
 recursive-include doc Makefile make.bat *.rst *.py *.ipynb *.bib

diff --git a/RELEASE.rst b/RELEASE.rst
@@ -9,9 +9,9 @@ kikuchipy's branching model is similar to the Gitflow Workflow (`original blog p
   branch v<major>.<minor>.<patch> off of the `main` branch locally instead. Ideally, a
   patch release should be made immediately after a bug fix has been made. Therefore, it
   might be best to do the release updates, listed in the following steps, directly on
-  the patch release branch, so that no separate branch has to be made. This patch
-  release branch should of course be branched off of `main`.
-- Increment the version number in `release.py`. Review and clean up `doc/changelog.rst`
+  the bug fix branch, so that no separate patch release branch has to be made. The bug
+  fix branch should of course be branched off of `main`.
+- Increment the version number in `release.py`. Review and clean up `CHANGELOG.rst`
   as per Keep a Changelog. Make sure all contributors and reviewers are acknowledged.
 - Make a PR of the release branch to `main`. Discuss the changelog with others, and
   make any changes *directly* to the release branch. Merge the branch into `main`. Then

diff --git a/doc/bibliography.bib b/doc/bibliography.bib
@@ -152,6 +152,18 @@ @article{pang2020optimization
     year = {2020},
     pages = {112876}
 }
+@article{singh2016orientation,
+	author = {Singh, S. and {De Graef}, Marc},
+	doi = {10.1088/0965-0393/24/8/085013},
+	issn = {1361651X},
+	journal = {Modelling and Simulation in Materials Science and Engineering},
+	keywords = {cubochoric representation, dictionary indexing, orientation sampling, uniform sampling},
+	number = {8},
+	publisher = {IOP Publishing},
+	title = {{Orientation sampling for dictionary-based diffraction pattern indexing methods}},
+	volume = {24},
+	year = {2016}
+}
 @article{singh2017application,
 	author = {Singh, Saransh and Ram, Farangis and {De Graef}, Marc},
 	doi = {10.1107/S1600576717014200},