[BUGFIX] Remove bad copies in docs build procedure#202
[BUGFIX] Remove bad copies in docs build procedure#202misi9170 merged 1 commit intoNatLabRockies:developfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR cleans up the deploy-pages CI workflow by removing operations that became obsolete after PR #201 consolidated example documentation. PR #201 moved example documentation from individual README.md files in example directories to consolidated markdown files directly in docs/examples/, making the copy operations unnecessary.
Changes:
- Removed 29 lines of obsolete file copying operations that attempted to copy non-existent README.md files
- Removed temporary debug code that was used to troubleshoot directory structure
- Removed redundant commented-out build step
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Thanks @paulf81 . I've confirmed that the documentation builds correctly for me now locally. Looking back at previous deploy-pages actions, it seems that something similar happened the previous time the deploy-pages action ran: https://github.com/NatLabRockies/hercules/actions/runs/21373301601/job/61523148965. I think in that case, I think the copying failed because the 02 example was moved to 02a without updating the name in the copying procedure. Now that we are not copying readmes around, that shouldn't be an issue. I'm going to approve and merge this. Hopefully, that clears things up and the documentation will build successfully. |
|
After merging, I manually triggered the deploy-pages workflow. That completed successfully and the docs now have the examples as expected (e.g. https://natlabrockies.github.io/hercules/examples/01_wind_farm_dof1_model.html) |
|
Thanks!! |
PR #201 cleaned up the docs/examples and consolidated documentation of the examples into docs/examples and removed the README files within each folder (following the approach in Hycon). The deploy-pages CI should have been updated to no longer copy those READMEs in the doc structure as we had done before (see failed action here).
This PR fixes that by removing code to copy readmes that are no longer in the examples.
It also removes some no longer needed debug code and commented out code