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 metadata, MVA notebooks, update README with Sphinx gallery #285

Merged
merged 5 commits into from
Jan 13, 2021

Conversation

hakonanes
Copy link
Member

@hakonanes hakonanes commented Jan 13, 2021

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

Description of the change

  • Migrate user guide reST documentation files explaining the signal metadata structures and multivariate analysis (MVA) to Jupyter Notebooks. The MVA one includes part of the denoising procedure explained in this conference paper
  • Add a thumbnail gallery from the notebooks in the README, via nbsphinx. This adds a [doc] dependency on sphinx-gallery >= 0.6.
  • Minor additions and changes to the contributing guide

Close #238.

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 documentation This relates to the documentation maintenance This relates to package maintenance labels Jan 13, 2021
@hakonanes hakonanes added this to the v0.3.0 milestone Jan 13, 2021
@hakonanes
Copy link
Member Author

Yeah... The gallery won't work in the README file. Will have to find a better way to include it there.

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 Author

Visit https://kikuchipy--285.org.readthedocs.build/en/285/ built from this PR to see the thumbnail gallery in action!

@hakonanes hakonanes merged commit 630d8b7 into pyxem:master Jan 13, 2021
@hakonanes hakonanes deleted the sphinx-gallery-readme branch January 13, 2021 17:19
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 maintenance This relates to package maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use Sphinx gallery for simple, focused example uses
1 participant