Skip to content

Commit

Permalink
Add note about txt vs rst extension for docs (#1239)
Browse files Browse the repository at this point in the history
  • Loading branch information
sfc-gh-turbaszek authored Jun 21, 2024
1 parent 3a67096 commit 768632c
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/snowflake/cli/app/dev/docs/generator.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,9 @@ def _render_usage(
arguments.append(param)
else:
options.append(param)

# RST files are presumed to be standalone pages in the docs with a matching item in the left nav.
# Included files, which these are, need to use the .txt extension.
file_path = root / f"usage-{command_name}.txt"
log.info("Creating %s", file_path)
with file_path.open("w+") as fh:
Expand Down

0 comments on commit 768632c

Please sign in to comment.