Skip to content

Add stable cf-docs snippet tags#5732

Open
danielporterda wants to merge 3 commits into
canton-network:mainfrom
danielporterda:splice-snippet-tags-source
Open

Add stable cf-docs snippet tags#5732
danielporterda wants to merge 3 commits into
canton-network:mainfrom
danielporterda:splice-snippet-tags-source

Conversation

@danielporterda

@danielporterda danielporterda commented May 28, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds stable CF_DOCS_SPLICE_SNIPPET_* RST comment tags around the Splice documentation ranges consumed by cf-docs external snippet generation. This lets cf-docs extract snippets by source tags instead of brittle line numbers.

Six implicit literal blocks are converted to explicit code-block directives so the tag comments can wrap the exact snippet body cleanly without changing the rendered intent. I also fixed one adjacent inline-literal spacing typo caught by sphinx-lint.

Confirmed that existing docs generation still works.

@danielporterda danielporterda force-pushed the splice-snippet-tags-source branch from 8be6e93 to 2eca7a0 Compare May 28, 2026 15:44
@danielporterda danielporterda marked this pull request as ready for review May 28, 2026 15:49
@isegall-da

Copy link
Copy Markdown
Contributor

(see slack, I don't understand what we're trying to do. These snippets are no longer maintained in Splice, so why do we care about tagging them??)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants