From 800a2e2d35f6799603d71beb38563afb87e7084b Mon Sep 17 00:00:00 2001 From: Rob Cowsill <42620235+rcowsill@users.noreply.github.com> Date: Thu, 6 May 2021 23:14:49 +0100 Subject: [CI:DOCS] Stop conversion of `--` into en dash In the documentation source `--` is only used in long option names or console output. Currently any unescaped `--` that's not in a code block/inline gets converted into a single "en dash". This is confusing to the reader because long options start with two dashes, not one. This switches off the dash transformation in Sphinx. Quotation marks, apostrophes and ellipses are still transformed as before. It also switches off all smart transforms in the podman-remote windows documentation build. This matches the Linux man page build, which doesn't use smart transforms. Signed-off-by: Rob Cowsill <42620235+rcowsill@users.noreply.github.com> --- docs/remote-docs.sh | 2 +- docs/source/conf.py | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/remote-docs.sh b/docs/remote-docs.sh index b1682e9cd..8249fc497 100755 --- a/docs/remote-docs.sh +++ b/docs/remote-docs.sh @@ -80,7 +80,7 @@ function html_fn() { local link=$(sed -e 's?.so man1/\(.*\)?\1?' <$dir/links/${file%.md}) markdown=$dir/$link.md fi - pandoc --ascii --standalone \ + pandoc --ascii --standalone --from markdown-smart \ --lua-filter=docs/links-to-html.lua \ --lua-filter=docs/use-pagetitle.lua \ -o $TARGET/${file%%.*}.html $markdown diff --git a/docs/source/conf.py b/docs/source/conf.py index 52869baf4..7a180e5ef 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -44,6 +44,10 @@ exclude_patterns = [] master_doc = "index" +# Configure smartquotes to only transform quotes and ellipses, not dashes +smartquotes_action = "qe" + + # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for -- cgit v1.2.3-54-g00ecf