Skip to content

doc_gen_cli collects and stores snippets in a second file #131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 15, 2025
Merged

doc_gen_cli collects and stores snippets in a second file #131

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
277ee79
doc_gen_cli collects and stores snippets in a second file
DavidSouther Jan 15, 2025
6a7684b
Update tests
DavidSouther Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion aws_doc_sdk_examples_tools/doc_gen_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
import logging

from .doc_gen import DocGen, DocGenEncoder
from .entities import EntityErrors

logging.basicConfig(level=logging.INFO)

Expand All @@ -28,6 +27,12 @@ def main():
type=str,
help="Output a JSON version of the computed DocGen with some properties stripped out. Includes any errors.",
)
parser.add_argument(
"--write-snippets",
default="doc_gen_snippets.json",
type=str,
help="Output a JSON version of the computed DocGen with only snippets and snippet files. Separates snippet content from metadata content.",
)

parser.add_argument(
"--strict",
Expand Down Expand Up @@ -61,6 +66,19 @@ def main():
with open(args.write_json, "w") as out:
out.write(serialized)

for root in args.from_root:
merged_doc_gen.collect_snippets(Path(root))

serialized_snippets = json.dumps(
{
"snippets": merged_doc_gen.snippets,
"snippet_files": merged_doc_gen.snippet_files,
},
cls=DocGenEncoder,
)
with open(args.write_snippets, "w") as out:
out.write(serialized_snippets)


if __name__ == "__main__":
main()
Loading