docs: remove private files in doc build#829
Merged
sesmart merged 9 commits intoamazon-braket:mainfrom Feb 13, 2026
Merged
Conversation
sesmart
changed the title
speller26
reviewed
Feb 5, 2026
| with open("docs/_NOTEBOOKS.md",'w') as fp: | ||
| fp.write(main_body) | ||
| print("docs/_NOTEBOOK.md updated!") | ||
| return main_body |
Member
There was a problem hiding this comment.
Why do this and the next file need this new return line?
Contributor
Author
There was a problem hiding this comment.
This is so you can test the output here (see test_matching_README) - the README is the one public file that should not be modified directly. Q generally is how to prevent that.
In this PR, this test tries to check that. You also could (1) move the build script to python and just have everything be in python, or (2) have a more complex build_readme.sh, that can write to other locations and do cleanup, but this seemed simple enough as we were already verifying that the index and notebook entries build okay.
speller26
reviewed
Feb 5, 2026
speller26
approved these changes
Feb 13, 2026
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
2 participants
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.
Issue #, if available:
Close #828; also improves doc testing
Description of changes:
Removed non-user generated files from
docs/; changed some private vs public naming to avoid confusion. All public .md files can be edited and will not be overwritten, except forREADME.md.Furthermore, we now have a test that the current README generated file is the same as the previous one. This helps testing when it should have been run and it was not, or if users tried to build the README.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.