remote/sqlite-utils
1
0
Fork 0
mirror of https://github.com/simonw/sqlite-utils.git synced 2026-07-23 17:34:32 +02:00
Code Issues Projects Releases Packages Wiki Activity

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

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

2
docs/cli.rst
View file

@ -3018,7 +3018,7 @@ See this `SpatiaLite Cookbook recipe <http://www.gaia-gis.it/gaia-sins/spatialit
Installing packages
===================
The :ref:`convert command <cli_convert>` and the :ref:`insert -\\-convert <cli_insert_convert>` and :ref:`query -\\-functions <cli_query_functions>` options can be provided with a Python script that imports additional modules from the ``sqlite-utils`` environment.
The :ref:`convert command <cli_convert>` and the :ref:`insert --convert <cli_insert_convert>` and :ref:`query --functions <cli_query_functions>` options can be provided with a Python script that imports additional modules from the ``sqlite-utils`` environment.
You can install packages from PyPI directly into the correct environment using ``sqlite-utils install <package>``. This is a wrapper around ``pip install``.

5
docs/conf.py
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