[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>
This commit is contained in:
Rob Cowsill 2021-05-06 23:14:49 +01:00
parent 034470e5be
commit 800a2e2d35
No known key found for this signature in database
GPG Key ID: DDDCCC475216DA36
2 changed files with 5 additions and 1 deletions

View File

@ -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

View File

@ -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