Skip to content

fix: fix en-dash rendering in docs ref links (fixes #493) - #860

Closed
KooshaPari wants to merge 1 commit into
simonw:mainfrom
KooshaPari:fix-2-docs-smartquotes
Closed

KooshaPari wants to merge 1 commit into
simonw:mainfrom
KooshaPari:fix-2-docs-smartquotes

Conversation

@KooshaPari

@KooshaPari KooshaPari commented Sep 13, 2026

Copy link
Copy Markdown

Fixes #493

Changes

  • Moved CLI option names (like --not-null, --default, --replace, --alter, --functions, --init-spatialite) out of :ref: link text in python-api.rst into inline literal markup
  • Sphinx smartquotes converts -- to en-dash inside :ref: role content, but skips inline literal markup (--option)
  • This preserves the en-dash rendering for autodoc parameter separators while fixing the CLI option rendering

Before

:ref:`sqlite-utils insert --not-null and --default <cli_defaults_not_null>`

Renders as: sqlite-utils insert –not-null and –default

After

:ref:`sqlite-utils insert <cli_defaults_not_null>` ``--not-null`` and ``--default``

Renders as: sqlite-utils insert --not-null and --default


📚 Documentation preview 📚: https://sqlite-utils--860.org.readthedocs.build/en/860/

Copilot AI lite review requested due to automatic review settings September 13, 2026 06:05

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@KooshaPari KooshaPari closed this by deleting the head repository Sep 13, 2026
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.

Tiny typographical error in install/uninstall docs

2 participants