Add wrapping guide to docs #98
Merged
Conversation
This file contains 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
wkearn
approved these changes
Dec 5, 2024
docs/wrapping.ipynb
Outdated
| "\n", | ||
| "7. **examples/** If you want to provide an example as documentation for your function, create a new Jupyter notebook here. You can fill the file however you see fit, but make sure to include a section title for the file by making the first line your title and underlining it with `====`.\n", | ||
| "\n", | ||
| "8. **docs/examples.rst** If you added a new example, include it in the example gallery by adding a new line: `/_temp/name_of_your_example`\n", |
There was a problem hiding this comment.
This is out of date as of #96. It should be /examples/name_of_your_example
Following the changes in TopoToolbox#96
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This should contain all changes to the documentation originally made in #72 to add a guide for wrapping libtopotoolbox functions.
closes #76