docs: keep CLI options literal in Python API cross-links - #848
Open
fly1d wants to merge 1 commit into
Open
Conversation
Refs simonw#493; follow-up to simonw#844. OpenAI Codex assisted with implementation and verification. Human review remains required.
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
1 participant
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.
Summary
Sphinx's smartquotes transform rewrites
--as an en dash when an option appears inside:ref:link text. Issue #493 tracks this rendering problem, and #844 addresses the two affected links in the install section. Six CLI cross-links indocs/python-api.rststill had the same issue.This PR updates only those six notes by keeping the command name as an internal reference and rendering each option as an inline literal. The generated documentation now preserves copyable
--attach,--not-null,--default,--replace,--alter,--functions, and--init-spatialiteflags.Verification
uv run --group docs sphinx-build -W -b html docs /tmp/sqlite-utils-docs-builduv run cog --check README.md docs/*.rstuv run --group docs codespell docs/python-api.rst --ignore-words docs/codespell-ignore-words.txtgit diff --checkA full Sphinx linkcheck also ran. It reported two pre-existing unrelated broken links in
docs/contributing.rstand the existing WGS84 link indocs/python-api.rst; neither file location was changed by this PR.Documentation only; no runtime behavior changes and no changelog entry is needed.
Related to #493. Follow-up to #844.
OpenAI Codex assisted with implementation and verification. Human review remains required.
📚 Documentation preview 📚: https://sqlite-utils--848.org.readthedocs.build/en/848/