fix code samples in documentation #535
Merged
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
The code samples to render properly have to be valid rst literal blocks (https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#literal-blocks). The most affected are multi-line code samples that are joined to a singe line, see https://sleap.ai/api/sleap.io.dataset.html.
|
outcome: |
|
LGTM! Thanks @smidm! |
talmo
added a commit
that referenced
this pull request
Jun 17, 2021
* Set Twine version to fix pypi uploads on build - twine v3.4.x and greater seems to have issues with our build system since we have an older version of `importlib_metadata` * Revert changes from merge into main * Bump version to 1.1.3 * Update docs * fix code samples in documentation (#535) The code samples to render properly have to be valid rst literal blocks (https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#literal-blocks). The most affected are multi-line code samples that are joined to a singe line, see https://sleap.ai/api/sleap.io.dataset.html. * Minor typo fixed (#538) * Add CLI options for specifying the GPU when training (#547) * Add GPU specification to training CLI * Update CLI docs * Set linter version * Minor QOL update (#562) * Add score metadata to the exported HDF5 analysis files * Fix and add test for labels.numpy() * Add some tweaks and docs to video rendering * Add model describer to sleap-inspect CLI * Minor logging * CLI tweak * Tweak visual indicator of not-visible points * Color untracked instances consistently * Track removal utilities - Add menu option: Tracks -> Delete All Tracks - Add Labels.remove_all_tracks() method - Tests * Try adding token to codecov action * Pin black formatter version and relint * Bump minor version * Update minor version in docs * Disable verbose coverage uploading * Update codecov badge branch Co-authored-by: Matěj 8000 Šmíd <m@matejsmid.cz> Co-authored-by: Darío Hereñú <magallania@gmail.com>
talmo
added a commit
that referenced
this pull request
Aug 2, 2021
* Set Twine version to fix pypi uploads on build - twine v3.4.x and greater seems to have issues with our build system since we have an older version of `importlib_metadata` * Revert changes from merge into main * Bump version to 1.1.3 * Update docs * fix code samples in documentation (#535) The code samples to render properly have to be valid rst literal blocks (https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#literal-blocks). The most affected are multi-line code samples that are joined to a singe line, see https://sleap.ai/api/sleap.io.dataset.html. * Minor typo fixed (#538) * Add CLI options for specifying the GPU when training (#547) * Add GPU specification to training CLI * Update CLI docs * Set linter version * Minor QOL update (#562) * Add score metadata to the exported HDF5 analysis files * Fix and add test for labels.numpy() * Add some tweaks and docs to video rendering * Add model describer to sleap-inspect CLI * Minor logging * CLI tweak * Tweak visual indicator of not-visible points * Color untracked instances consistently * Track removal utilities - Add menu option: Tracks -> Delete All Tracks - Add Labels.remove_all_tracks() method - Tests * Try adding token to codecov action * Pin black formatter version and relint * Bump minor version * Update minor version in docs * Disable verbose coverage uploading * Update codecov badge branch * Empty instance fixes (#569) * Fix augmentation with no instances * Add Labels.copy * Add empty instance removal methods * Add empty instance removal in provider constructor * Fix augmentation test * Properly ignore empty instances and frames in DLC import * Fix test * Lint * Small GUI fixes (#570) * Increase range for number of instances to cull * Add background box to missing nodes for improved visibility * Lint * Fix predicted instance coloring order * Add node label font size configuration * Fix single instance predictor not using peak threshold param (#571) * Skeleton merge conflicts (#572) * Fix video repr when shape data not available * Merge incompletely matching skeletons into union of nodes * Add a little extra padding when filling in missing points * Add automatic call to _fix_array() when accessing or setting nodes * Add node data merging * Add test for predicted instance data merge * Add node merging - Will update base node with merge node when renaming from GUI * Lint * Fix broken tests * Labels.split() (#574) * Add labels.split() utility * Lint * High level load metrics (#573) - Add `sleap.load_metrics()` - Example notebook * Pre-1.1.5 updates - Remove version from some places - Add open in colab button in model eval notebook - Update installation doc - Add a general Help page - Add some deep links to the CLI sections * Update readme with help links Co-authored-by: Matěj Šmíd <m@matejsmid.cz> Co-authored-by: Darío Hereñú <magallania@gmail.com>
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.
The code samples to render properly have to be valid rst literal blocks (https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#literal-blocks). The most affected are multi-line code samples that are joined to a singe line, see https://sleap.ai/api/sleap.io.dataset.html.
The leading " > " could be possibly removed to make copying the snippets easy.