Fix en-dash rendering in install/uninstall docs by disabling smartquotes

Disable Sphinx smartquotes globally to prevent -- from being
transformed into an en-dash in CLI documentation. Previously,
the escaping approach (\--) was attempted but did not work
inside :ref: roles as confirmed by the maintainer.

Removes the earlier workaround escaping in cli.rst since the
global setting handles all occurrences properly.

Closes #493
This commit is contained in:
Muhamed Fazal PS 2026-07-16 19:15:54 +05:30
commit 9db0308e72
2 changed files with 6 additions and 1 deletions

View file

@ -146,6 +146,11 @@ pygments_style = "sphinx"
# Only syntax highlight of code-block is used:
highlight_language = "none"
# Disable smartquotes to prevent -- from being transformed to en-dash.
# This is important for CLI documentation where --options must display
# as literal double dashes. See #493.
smartquotes = False
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False