docs: render --convert and --functions literally in install section#737
Open
c-tonneslan wants to merge 1 commit into
Open
docs: render --convert and --functions literally in install section#737c-tonneslan wants to merge 1 commit into
c-tonneslan wants to merge 1 commit into
Conversation
The double dashes were hitting Sphinx's smartquotes inside the `:ref:` display text and coming out as en-dashes. Move them into inline code spans and reword the sentence around the links so smartquotes never sees them. Closes simonw#493. Signed-off-by: Charlie Tonneslan <cst0520@gmail.com>
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.
Sphinx's smartquotes was turning `--convert` and `--functions` into en-dashes because they were sitting in the display text of a `:ref:` block, where escapes don't reach. Reworded the sentence so the literal options live inline in code spans (``--convert`` / ``--functions``) and the `:ref:` links point at the commands themselves. Same content, but the dashes render right now.
Closes #493.
📚 Documentation preview 📚: https://sqlite-utils--737.org.readthedocs.build/en/737/