Fix #1820: Automate directory structure documentation via script and Makefile integration #3495
+131
−0
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 PR addresses Issue #1820 by automating the generation of PEcAn's directory structure documentation.
Changes Made:
Added a new script: scripts/generate_dir_structure.sh
Recursively lists all folders in the project
Outputs results to documentation/directory_structure.md in a clean Markdown format
Updated scripts/README.md
Included description of the new script under Documentation and Dependencies
Updated the root Makefile
Introduced a new target: generate-dir-doc
This target runs the script automatically as part of the documentation workflow
How to Use:
To regenerate the directory documentation manually, run in bash: make generate-dir-doc
This will update documentation/directory_structure.md with the latest folder structure.