Improve readthedoc layout structure#52
Merged
Merged
Conversation
… preserve metadata Co-authored-by: MGAMZ <57469116+MGAMZ@users.noreply.github.com>
…servation Co-authored-by: MGAMZ <57469116+MGAMZ@users.noreply.github.com>
Co-authored-by: MGAMZ <57469116+MGAMZ@users.noreply.github.com>
- Added _generate_metadata_for_folder() helper method in BaseITKProcessor - Reduced code duplication across 5 modules (SingleFolderProcessor, DatasetProcessor, FormatConverter, MonaiConverter, TorchIOConverter) - Net reduction of 62 lines of duplicated code - Improved maintainability and abstraction layer separation Co-authored-by: MGAMZ <57469116+MGAMZ@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restructures the ReadTheDocs documentation by splitting the monolithic preprocessing.md guide into individual tool-specific pages, and adds metadata preservation functionality to prevent loss of metadata when files are skipped during reprocessing.
Key changes:
- Documentation split into individual tool pages (itk_check, itk_resample, itk_orient, itk_patch, itk_aug, itk_extract, itk_convert)
- New metadata preservation logic that loads and merges existing metadata before processing
- Comprehensive test coverage for metadata preservation across multiple processors
- Removal of faq.md file
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Updated navigation structure to use "Processing Tools" section with individual tool pages, removed FAQ entry |
| docs/preprocessing.md | Reduced to overview page with general notes and best practices only |
| docs/itk_*.md | New individual documentation pages for each tool (check, resample, orient, patch, aug, extract, convert) |
| docs/index.md | Updated table of contents to reflect new documentation structure |
| docs/contributing.md | Updated reference from preprocessing.md to individual tool documentation files |
| docs/faq.md | Removed entire FAQ file |
| itkit/process/metadata_models.py | Added load_and_merge method to MetadataManager for merging existing metadata |
| itkit/process/base_processor.py | Added metadata preservation methods and integration into process() workflow |
| itkit/process/itk_convert_*.py | Integrated metadata preservation for TorchIO, MONAI, and format conversion processors |
| tests/test_itk_*.py | Added comprehensive tests for metadata preservation on skip and partial processing scenarios |
| .pre-commit-config.yaml | Removed redundant pyright additional_dependencies list |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Test Results288 tests 288 ✅ 45s ⏱️ Results for commit e3783f5. ♻️ This comment has been updated with latest results. |
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
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.
📚 Documentation preview 📚: https://ITKIT--52.org.readthedocs.build/en/52/