docs: comprehensive documentation cleanup and improved generation workflow #597
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
|
🤖 I've automatically formatted the code in this PR using:
Please pull the latest changes before making further edits. |
- Removed 5 stale UMEP HTML files from docs/source/images/ - Fixed outdated YAML API comment in workflow.rst (fully functional, not in development) - Added reference to issue #581 for pending table-to-YAML conversion - Removed deprecated warning from README.md developer section
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This PR performs essential documentation cleanup, removing outdated content and fixing inaccuracies.
Changes Made
🧹 Removed Outdated Content
Deleted 5 stale UMEP HTML files from
docs/source/images/:File_LCZdialog1.htmFile_SEBE_noVeg.htmFile_SuewsAdvanced.htmFile_SuewsAdvanced.htm.8wjizt1.partialFile_SuewsSimple.htmThese were incomplete MediaWiki/UMEP wiki exports that don't belong in core SUEWS documentation.
Removed deprecated warning from README.md developer section that was marked "will be updated"
📝 Fixed Documentation Inaccuracies
workflow.rst- changed comment from "Direct YAML loading in functional API is in development" to accurate description (YAML API is fully functional through SUEWSSimulation class)Impact
Testing
Related Issues
References #581 for pending table-to-YAML conversion feature