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

Add longer/shorter examples section to docs, restrict Sphinx version #403

Merged
merged 5 commits into from
Aug 2, 2021

Conversation

hakonanes
Copy link
Member

Description of the change

  • Add shorter and longer examples section to the documentation. I decided this was the best place for the M&M 2021 Sunday Short Course notebook (original notebook).
  • Add a short example showing how to save a master pattern in the stereographic to an image file without a background (I frequently use this script myself).
  • Restrict newest Sphinx version to 4.0.2 to fix Doc build failing due to known issue #401.
  • Move all user guide notebooks to a doc/user_guide directory. This means all URLs will be "https:/ /kikuchipy.org/en/stable/user_guide/load_save_data.html" and similar, where the "/user_guide" is new. This is done to add some order to the doc/ directory.

Progress of the PR

For reviewers

  • 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.

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes added the documentation This relates to the documentation label Aug 2, 2021
@hakonanes hakonanes added this to the v0.5.0 milestone Aug 2, 2021
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes merged commit 2d26397 into pyxem:master Aug 2, 2021
@hakonanes hakonanes deleted the documentation-examples-section branch August 2, 2021 18:18
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.

Doc build failing due to known issue
1 participant