added examples navigation and example1 skeleton #248
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jlaehne
reviewed
Jan 13, 2026
| :caption: Tutorials | ||
|
|
||
| Demo notebooks <https://github.com/LumiSpy/lumispy-demos> | ||
| examples/examples_index.rst |
Contributor
There was a problem hiding this comment.
To align with the HyperSpy and ExSpy documentations, I would create a separate TOC section directly after the user guide.
Contributor
|
Can you also include the configuration for the gallery extension in this PR? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added a new navigation page to the lumispy doc which provides space for examples how to use lumispy.
(Comparable to https://hyperspy.org/hyperspy-doc/current/auto_examples/index.html)
Also added an example skeleton (example1.rst).