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 Documentation Examples #209

Merged
merged 13 commits into from
May 13, 2024
Merged

Add Documentation Examples #209

merged 13 commits into from
May 13, 2024

Conversation

CSSFrancis
Copy link
Member

@CSSFrancis CSSFrancis commented Apr 17, 2024

Description of the change

This depends on #205 and adds Examples to the documentation.

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 CHANGELOG.rst.
  • Contributor(s) are listed correctly in credits in diffsims/release_info.py and
    in .zenodo.json.

@CSSFrancis
Copy link
Member Author

@hakonanes Any chance you can look over this if you get the chance? Mostly it just copies the examples in orix/pyxem

@hakonanes
Copy link
Member

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 intensity attribute, e.g.).

@hakonanes hakonanes self-requested a review April 21, 2024 15:56
@hakonanes
Copy link
Member

I can review this once you rebase and make any changes you'd like.

@CSSFrancis
Copy link
Member Author

@hakonanes what is your opinion on including the examples for the distribution?

@hakonanes
Copy link
Member

I'd include them, as currently they are just small Python files.

@CSSFrancis
Copy link
Member Author

@hakonanes This is good to be reviewed when you have the chance.

doc/index.rst Outdated Show resolved Hide resolved
examples/creating_a_simulation_library/README.rst Outdated Show resolved Hide resolved
examples/creating_a_simulation_library/README.rst Outdated Show resolved Hide resolved
examples/creating_a_simulation_library/README.rst Outdated Show resolved Hide resolved
doc/conf.py Show resolved Hide resolved
@hakonanes hakonanes mentioned this pull request May 9, 2024
16 tasks
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>
@hakonanes
Copy link
Member

@CSSFrancis, if it's fine with you, I'll add the following fixes and updates to your branch:

  • Use numpydoc instead of sphinx.ext.napoleon, giving us useful warnings for how to improve our docstrings
  • Restructure doc/index.rst perfectly in line with orix (and fixing some links etc.)
  • Fix minigalleries in API (since we use custom templates, we have to add it explicitly, which I forgot; sorry!)
  • Rename Gallery of Examples -> Examples, and fix heading level (use === above and below)
  • Some other smaller things

@CSSFrancis
Copy link
Member Author

@CSSFrancis, if it's fine with you, I'll add the following fixes and updates to your branch:

  • Use numpydoc instead of sphinx.ext.napoleon, giving us useful warnings for how to improve our docstrings
  • Restructure doc/index.rst perfectly in line with orix (and fixing some links etc.)
  • Fix minigalleries in API (since we use custom templates, we have to add it explicitly, which I forgot; sorry!)
  • Rename Gallery of Examples -> Examples, and fix heading level (use === above and below)
  • Some other smaller thing

@hakonanes Go for it! I'm pretty much always okay with you adding things to my PR's :).

@hakonanes
Copy link
Member

Thanks, I've done so now. I'll go over the docs built in this PR tomorrow, and then we can merge and release.

@hakonanes hakonanes merged commit cc8b0a7 into pyxem:main May 13, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants