-
Notifications
You must be signed in to change notification settings - Fork 27
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 Documentation Examples #209
Conversation
6092cef
to
1f07bca
Compare
@hakonanes Any chance you can look over this if you get the chance? Mostly it just copies the examples in orix/pyxem |
Yes, I can. But since this depends on #205, I'll do so after that one is reviewed and merged (I have some questions regarding the |
I can review this once you rebase and make any changes you'd like. |
@hakonanes what is your opinion on including the examples for the distribution? |
I'd include them, as currently they are just small Python files. |
@hakonanes This is good to be reviewed when you have the chance. |
examples/creating_a_simulation_library/simulating_diffraction_patterns.py
Outdated
Show resolved
Hide resolved
examples/creating_a_simulation_library/simulating_diffraction_patterns.py
Outdated
Show resolved
Hide resolved
examples/creating_a_simulation_library/simulating_diffraction_patterns.py
Outdated
Show resolved
Hide resolved
examples/creating_a_simulation_library/simulating_diffraction_patterns.py
Outdated
Show resolved
Hide resolved
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>
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>
@CSSFrancis, if it's fine with you, I'll add the following fixes and updates to your branch:
|
@hakonanes Go for it! I'm pretty much always okay with you adding things to my PR's :). |
Thanks, I've done so now. I'll go over the docs built in this PR tomorrow, and then we can merge and release. |
Description of the change
This depends on #205 and adds Examples to the documentation.
Progress of the PR
For reviewers
__init__.py
.unreleased section in
CHANGELOG.rst
.credits
indiffsims/release_info.py
andin
.zenodo.json
.