Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace reST user guide with Jupyter Notebook for image quality guide, remove unused images #244

Merged
merged 2 commits into from
Nov 4, 2020

Conversation

hakonanes
Copy link
Member

Signed-off-by: Håkon Wiik Ånes hwaanes@gmail.com

Description of the change

  • Replace reST user guide file with Jupyter Notebook for image quality guide, using the kikuchipy.data.nickel_ebsd_large() dataset (from kikuchipy-data).
  • Remove unused documentation images, since these are now generated from the notebook 🎉
  • Changelog updated.

Progress of the PR

For reviewers

  • Check that the PR title is short, concise, and will make sense 1 year
    later.
  • Check that new functions are imported in corresponding __init__.py.
  • Check that new features, API changes, and deprecations are mentioned in
    the unreleased section in doc/changelog.rst.

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes added the documentation This relates to the documentation label Nov 4, 2020
@hakonanes hakonanes added this to the v0.3.0 milestone Nov 4, 2020
@hakonanes hakonanes self-assigned this Nov 4, 2020
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes merged commit 6617120 into pyxem:master Nov 4, 2020
@hakonanes hakonanes deleted the user-guide-notebook-feature-maps branch November 4, 2020 01:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This relates to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant