-
Notifications
You must be signed in to change notification settings - Fork 23
No apparent way to use cross-references #8
Description
I've been trying to cross-reference arguments in my autoprogram output and can't find any viable way to do it.
According to python3 -m sphinx.ext.intersphinx, these are the cross-reference targets that are being generated...
std:cmdoption
quicktile.--bindkeys cli.html#cmdoption-quicktile-b
quicktile.--daemonize cli.html#cmdoption-quicktile-d
quicktile.--debug cli.html#cmdoption-quicktile-debug
quicktile.--help cli.html#cmdoption-quicktile-h
quicktile.--no-workarea cli.html#cmdoption-quicktile-no-workarea
quicktile.--show-actions cli.html#cmdoption-quicktile-show-actions
quicktile.--show-bindings cli.html#cmdoption-quicktile-show-bindings
quicktile.--version cli.html#cmdoption-quicktile-v
quicktile.-V cli.html#cmdoption-quicktile-v
quicktile.-b cli.html#cmdoption-quicktile-b
quicktile.-d cli.html#cmdoption-quicktile-d
quicktile.-h cli.html#cmdoption-quicktile-h
quicktile.command cli.html#cmdoption-quicktile-arg-command
...and, according to the Sphinx docs, cmdoption is a deprecated alias for option, but I get WARNING: unknown option when I try to use :option: or :any: to cross-reference either quicktile.--show-bindings or --show-bindings.
I've taken to the hacky and not-quite-right-looking solution of using this syntax for my option cross-references:
`-\\-show-bindings <cli.html#cmdoption-quicktile-show-bindings>`_
EDIT: The -\\- hack is broken in the manpage output. I had to resort to just disabling SmartyPants.
EDIT: Correction: I have to special-case manpage output because html_use_smartypants = False is getting ignored.