This issue was initially found on Modules online documentation. But as you also use Sphinx I think it could also be interesting for clustershell.
By default Sphinx applies a smartquotes (also called smartypants) mechanism to convert quotes and dashes to lang-specific entities. This is kinda bad for command-line description as it automatically translates -- into –, which most of the times leads to an error on tools.
smartquotes has a significant impact on the Command line reference part of the pcocc documentation. For instance on the option description in the Instantiate or restore a virtual cluster (interactive mode) guide: the --alloc-script option is written –alloc-script.
This issue was initially found on Modules online documentation. But as you also use Sphinx I think it could also be interesting for clustershell.
By default Sphinx applies a
smartquotes(also calledsmartypants) mechanism to convert quotes and dashes to lang-specific entities. This is kinda bad for command-line description as it automatically translates--into–, which most of the times leads to an error on tools.smartquoteshas a significant impact on the Command line reference part of the pcocc documentation. For instance on the option description in the Instantiate or restore a virtual cluster (interactive mode) guide: the--alloc-scriptoption is written–alloc-script.