{ "content": [ { "type": "text", "text": "# rst2html5 (man)\n\n## NAME\n\nrst2html5 - convert reST documents to HTML 5\n\n## SYNOPSIS\n\nrst2html5 [options] [ []]\n\n## DESCRIPTION\n\nGenerates HTML5 documents from standalone reStructuredText sources. Reads from (de‐\nfault is stdin) and writes to (default is stdout). See <‐\nhttp://docutils.sf.net/docs/user/config.html> for the full reference.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (47 subsections)\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "rst2html5", "section": "", "mode": "man", "summary": "rst2html5 - convert reST documents to HTML 5", "synopsis": "rst2html5 [options] [ []]", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [ { "flag": "", "long": "--no-generator", "arg": null, "description": "Do not include a generator credit. --date, -d Include the date at the end of the document (UTC). --time, -t Include the time & date (UTC)." }, { "flag": "", "long": "--no-datestamp", "arg": null, "description": "Do not include a datestamp of any kind. --source-link, -s Include a \"View document source\" link. --source-url= Use for a source link; implies --source-link." }, { "flag": "", "long": "--no-source-link", "arg": null, "description": "Do not include a \"View document source\" link." }, { "flag": "", "long": "--toc-entry-backlinks", "arg": null, "description": "Link from section headers to TOC entries. (default)" }, { "flag": "", "long": "--toc-top-backlinks", "arg": null, "description": "Link from section headers to the top of the TOC." }, { "flag": "", "long": "--no-toc-backlinks", "arg": null, "description": "Disable backlinks to the table of contents." }, { "flag": "", "long": "--footnote-backlinks", "arg": null, "description": "Link from footnotes/citations to references. (default)" }, { "flag": "", "long": "--no-footnote-backlinks", "arg": null, "description": "Disable backlinks from footnotes and citations." }, { "flag": "", "long": "--section-numbering", "arg": null, "description": "Enable section numbering by Docutils. (default)" }, { "flag": "", "long": "--no-section-numbering", "arg": null, "description": "Disable section numbering by Docutils." }, { "flag": "", "long": "--strip-comments", "arg": null, "description": "Remove comment elements from the document tree." }, { "flag": "", "long": "--leave-comments", "arg": null, "description": "Leave comment elements in the document tree. (default) --strip-elements-with-class= Remove all elements with classes=\"\" from the document tree. Warning: poten‐ tially dangerous; use with caution. (Multiple-use option.) --strip-class= Remove all classes=\"\" attributes from elements in the document tree. Warning: potentially dangerous; use with caution. (Multiple-use option.) --report=, -r Report system messages at or higher than : \"info\" or \"1\", \"warning\"/\"2\" (de‐ fault), \"error\"/\"3\", \"severe\"/\"4\", \"none\"/\"5\" --verbose, -v Report all system messages. (Same as \"--report=1\".) --quiet, -q Report no system messages. (Same as \"--report=5\".) --halt= Halt execution at system messages at or above . Levels as in --report. De‐ fault: 4 (severe)." }, { "flag": "", "long": "--strict", "arg": null, "description": "Halt at the slightest problem. Same as \"--halt=info\". --exit-status= Enable a non-zero exit status for non-halting system messages at or above . Default: 5 (disabled)." }, { "flag": "", "long": "--debug", "arg": null, "description": "Enable debug-level system messages and diagnostics." }, { "flag": "", "long": "--no-debug", "arg": null, "description": "Disable debug output. (default) --warnings= Send the output of system messages to ." }, { "flag": "", "long": "--traceback", "arg": null, "description": "Enable Python tracebacks when Docutils is halted." }, { "flag": "", "long": "--no-traceback", "arg": null, "description": "Disable Python tracebacks. (default) --input-encoding=, -i Specify the encoding and optionally the error handler of input text. Default: :strict. --input-encoding-error-handler=INPUTENCODINGERRORHANDLER Specify the error handler for undecodable characters. Choices: \"strict\" (default), \"ignore\", and \"replace\". --output-encoding=, -o Specify the text encoding and optionally the error handler for output. Default: UTF-8:strict. --output-encoding-error-handler=OUTPUTENCODINGERRORHANDLER Specify error handler for unencodable output characters; \"strict\" (default), \"ignore\", \"replace\", \"xmlcharrefreplace\", \"backslashreplace\". --error-encoding=, -e Specify text encoding and error handler for error output. Default text encoding: sys‐ tem encoding. Default error handler: backslashreplace. --error-encoding-error-handler=ERRORENCODINGERRORHANDLER Specify the error handler for unencodable characters in error output. Default: back‐ slashreplace. --language=, -l Specify the language (as BCP 47 language tag). Default: en. --record-dependencies= Write output file dependencies to . --config= Read configuration settings from , if it exists. --version, -V Show this program's version number and exit. --help, -h Show this help message and exit." }, { "flag": "", "long": "--no-file-insertion", "arg": null, "description": "Disable directives that insert the contents of an external file; replaced with a \"warning\" system message." }, { "flag": "", "long": "--file-insertion-enabled", "arg": null, "description": "Enable directives that insert the contents of an external file. (default)" }, { "flag": "", "long": "--no-raw", "arg": null, "description": "Disable the \"raw\" directive; replaced with a \"warning\" system message." }, { "flag": "", "long": "--raw-enabled", "arg": null, "description": "Enable the \"raw\" directive. (default) --line-length-limit= Maximal number of characters in an input line. Default 10 000." }, { "flag": "", "long": "--pep-references", "arg": null, "description": "Recognize and link to standalone PEP references (like \"PEP 258\"). --pep-base-url= Base URL for PEP references (default \"http://www.python.org/dev/peps/\"). --pep-file-url-template= Template for PEP file part of URL. (default \"pep-%04d\")" }, { "flag": "", "long": "--rfc-references", "arg": null, "description": "Recognize and link to standalone RFC references (like \"RFC 822\"). --rfc-base-url= Base URL for RFC references (default \"http://tools.ietf.org/html/\"). --tab-width= Set number of spaces for tab expansion (default 8)." }, { "flag": "", "long": "--trim-footnote-reference-space", "arg": null, "description": "Remove spaces before footnote references." }, { "flag": "", "long": "--leave-footnote-reference-space", "arg": null, "description": "Leave spaces before footnote references. --syntax-highlight= Token name set for parsing code with Pygments: one of \"long\", \"short\", or \"none\" (no parsing). Default is \"long\". --smart-quotes= Change straight quotation marks to typographic form: one of \"yes\", \"no\", \"alt[erna‐ tive]\" (default \"no\"). --smartquotes-locales= Characters to use as \"smart quotes\" for ." }, { "flag": "", "long": "--word-level-inline-markup", "arg": null, "description": "Inline markup recognized at word boundaries only (adjacent to punctuation or white‐ space). Force character-level inline markup recognition with \"\" (backslash + space). Default." }, { "flag": "", "long": "--character-level-inline-markup", "arg": null, "description": "Inline markup recognized anywhere, regardless of surrounding characters. Backslash-es‐ capes must be used to avoid unwanted markup recognition. Useful for East Asian lan‐ guages. Experimental." }, { "flag": "", "long": "--no-doc-title", "arg": null, "description": "Disable the promotion of a lone top-level section title to document title (and subse‐ quent section title to document subtitle promotion; enabled by default)." }, { "flag": "", "long": "--no-doc-info", "arg": null, "description": "Disable the bibliographic field list transform (enabled by default)." }, { "flag": "", "long": "--section-subtitles", "arg": null, "description": "Activate the promotion of lone subsection titles to section subtitles (disabled by de‐ fault)." }, { "flag": "", "long": "--no-section-subtitles", "arg": null, "description": "Deactivate the promotion of lone subsection titles." }, { "flag": "", "long": "--embed-stylesheet", "arg": null, "description": "Embed the stylesheet(s) in the output HTML file. The stylesheet files must be acces‐ sible during processing. This is the default." }, { "flag": "", "long": "--link-stylesheet", "arg": null, "description": "Link to the stylesheet(s) in the output HTML file. Default: embed stylesheets. --stylesheet-dirs= Comma-separated list of directories where stylesheets are found. Used by --stylesheet-path when expanding relative path arguments. Default: \"['.', '/usr/share/docutils/writers/html5polyglot']\" --initial-header-level= Specify the initial header level. Default is 2 for \"

\". Does not affect document title & subtitle (see --no-doc-title). --footnote-references= Format for footnote references: one of \"superscript\" or \"brackets\". Default is \"brackets\". --attribution= Format for block quote attributions: one of \"dash\" (em-dash prefix), \"parenthe‐ ses\"/\"parens\", or \"none\". Default is \"dash\"." }, { "flag": "", "long": "--compact-lists", "arg": null, "description": "Remove extra vertical whitespace between items of \"simple\" bullet lists and enumerated lists. Default: enabled." }, { "flag": "", "long": "--no-compact-lists", "arg": null, "description": "Disable compact simple bullet and enumerated lists." }, { "flag": "", "long": "--compact-field-lists", "arg": null, "description": "Remove extra vertical whitespace between items of simple field lists. Default: en‐ abled." }, { "flag": "", "long": "--no-compact-field-lists", "arg": null, "description": "Disable compact simple field lists." }, { "flag": "", "long": "--embed-images", "arg": null, "description": "Embed images in the output HTML file, if the image files are accessible during pro‐ cessing." }, { "flag": "", "long": "--link-images", "arg": null, "description": "Link to images in the output HTML file. This is the default. --table-style=TABLESTYLE Added to standard table classes. Defined styles: borderless, booktabs, align-left, align-center, align- right, colwidths-auto. Default: \"\" --math-output=MATHOUTPUT Math output format (one of \"MathML\", \"HTML\", \"MathJax\", or \"LaTeX\") and option(s). De‐ fault: \"HTML math.css\"" }, { "flag": "", "long": "--xml-declaration", "arg": null, "description": "Prepend an XML declaration. (Thwarts HTML5 conformance.) Default: False" }, { "flag": "", "long": "--no-xml-declaration", "arg": null, "description": "Omit the XML declaration." }, { "flag": "", "long": "--cloak-email-addresses", "arg": null, "description": "Obfuscate email addresses to confuse harvesters while still keeping email links usable with standards- compliant browsers. RST2HTML5(1)" } ], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 4, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "General Docutils Options", "lines": 6 }, { "name": "--no-generator", "lines": 8, "long": "--no-generator" }, { "name": "--no-datestamp", "lines": 8, "long": "--no-datestamp" }, { "name": "--no-source-link", "lines": 2, "long": "--no-source-link" }, { "name": "--toc-entry-backlinks", "lines": 2, "long": "--toc-entry-backlinks" }, { "name": "--toc-top-backlinks", "lines": 2, "long": "--toc-top-backlinks" }, { "name": "--no-toc-backlinks", "lines": 2, "long": "--no-toc-backlinks" }, { "name": "--footnote-backlinks", "lines": 2, "long": "--footnote-backlinks" }, { "name": "--no-footnote-backlinks", "lines": 2, "long": "--no-footnote-backlinks" }, { "name": "--section-numbering", "lines": 2, "long": "--section-numbering" }, { "name": "--no-section-numbering", "lines": 2, "long": "--no-section-numbering" }, { "name": "--strip-comments", "lines": 2, "long": "--strip-comments" }, { "name": "--leave-comments", "lines": 24, "long": "--leave-comments" }, { "name": "--strict", "lines": 6, "long": "--strict" }, { "name": "--debug", "lines": 2, "long": "--debug" }, { "name": "--no-debug", "lines": 5, "long": "--no-debug" }, { "name": "--traceback", "lines": 2, "long": "--traceback" }, { "name": "--no-traceback", "lines": 41, "long": "--no-traceback" }, { "name": "Generic Parser Options", "lines": 1 }, { "name": "--no-file-insertion", "lines": 3, "long": "--no-file-insertion" }, { "name": "--file-insertion-enabled", "lines": 2, "long": "--file-insertion-enabled" }, { "name": "--no-raw", "lines": 2, "long": "--no-raw" }, { "name": "--raw-enabled", "lines": 5, "long": "--raw-enabled" }, { "name": "reStructuredText Parser Options", "lines": 1 }, { "name": "--pep-references", "lines": 8, "long": "--pep-references" }, { "name": "--rfc-references", "lines": 8, "long": "--rfc-references" }, { "name": "--trim-footnote-reference-space", "lines": 2, "long": "--trim-footnote-reference-space" }, { "name": "--leave-footnote-reference-space", "lines": 13, "long": "--leave-footnote-reference-space" }, { "name": "--word-level-inline-markup", "lines": 4, "long": "--word-level-inline-markup" }, { "name": "--character-level-inline-markup", "lines": 4, "long": "--character-level-inline-markup" }, { "name": "Standalone Reader", "lines": 1 }, { "name": "--no-doc-title", "lines": 3, "long": "--no-doc-title" }, { "name": "--no-doc-info", "lines": 2, "long": "--no-doc-info" }, { "name": "--section-subtitles", "lines": 3, "long": "--section-subtitles" }, { "name": "--no-section-subtitles", "lines": 2, "long": "--no-section-subtitles" }, { "name": "HTML-Specific Options", "lines": 13 }, { "name": "--embed-stylesheet", "lines": 3, "long": "--embed-stylesheet" }, { "name": "--link-stylesheet", "lines": 19, "long": "--link-stylesheet" }, { "name": "--compact-lists", "lines": 3, "long": "--compact-lists" }, { "name": "--no-compact-lists", "lines": 2, "long": "--no-compact-lists" }, { "name": "--compact-field-lists", "lines": 3, "long": "--compact-field-lists" }, { "name": "--no-compact-field-lists", "lines": 2, "long": "--no-compact-field-lists" }, { "name": "--embed-images", "lines": 3, "long": "--embed-images" }, { "name": "--link-images", "lines": 10, "long": "--link-images" }, { "name": "--xml-declaration", "lines": 2, "long": "--xml-declaration" }, { "name": "--no-xml-declaration", "lines": 2, "long": "--no-xml-declaration" }, { "name": "--cloak-email-addresses", "lines": 7, "long": "--cloak-email-addresses" } ] } ], "sections": { "NAME": { "content": "rst2html5 - convert reST documents to HTML 5\n", "subsections": [] }, "SYNOPSIS": { "content": "rst2html5 [options] [ []]\n", "subsections": [] }, "DESCRIPTION": { "content": "Generates HTML5 documents from standalone reStructuredText sources. Reads from (de‐\nfault is stdin) and writes to (default is stdout). See <‐\nhttp://docutils.sf.net/docs/user/config.html> for the full reference.\n", "subsections": [] }, "OPTIONS": { "content": "", "subsections": [ { "name": "General Docutils Options", "content": "--title=TITLE\nSpecify the document title as metadata.\n\n--generator, -g\nInclude a \"Generated by Docutils\" credit and link.\n" }, { "name": "--no-generator", "content": "Do not include a generator credit.\n\n--date, -d\nInclude the date at the end of the document (UTC).\n\n--time, -t\nInclude the time & date (UTC).\n", "long": "--no-generator" }, { "name": "--no-datestamp", "content": "Do not include a datestamp of any kind.\n\n--source-link, -s\nInclude a \"View document source\" link.\n\n--source-url=\nUse for a source link; implies --source-link.\n", "long": "--no-datestamp" }, { "name": "--no-source-link", "content": "Do not include a \"View document source\" link.\n", "long": "--no-source-link" }, { "name": "--toc-entry-backlinks", "content": "Link from section headers to TOC entries. (default)\n", "long": "--toc-entry-backlinks" }, { "name": "--toc-top-backlinks", "content": "Link from section headers to the top of the TOC.\n", "long": "--toc-top-backlinks" }, { "name": "--no-toc-backlinks", "content": "Disable backlinks to the table of contents.\n", "long": "--no-toc-backlinks" }, { "name": "--footnote-backlinks", "content": "Link from footnotes/citations to references. (default)\n", "long": "--footnote-backlinks" }, { "name": "--no-footnote-backlinks", "content": "Disable backlinks from footnotes and citations.\n", "long": "--no-footnote-backlinks" }, { "name": "--section-numbering", "content": "Enable section numbering by Docutils. (default)\n", "long": "--section-numbering" }, { "name": "--no-section-numbering", "content": "Disable section numbering by Docutils.\n", "long": "--no-section-numbering" }, { "name": "--strip-comments", "content": "Remove comment elements from the document tree.\n", "long": "--strip-comments" }, { "name": "--leave-comments", "content": "Leave comment elements in the document tree. (default)\n\n--strip-elements-with-class=\nRemove all elements with classes=\"\" from the document tree. Warning: poten‐\ntially dangerous; use with caution. (Multiple-use option.)\n\n--strip-class=\nRemove all classes=\"\" attributes from elements in the document tree. Warning:\npotentially dangerous; use with caution. (Multiple-use option.)\n\n--report=, -r \nReport system messages at or higher than : \"info\" or \"1\", \"warning\"/\"2\" (de‐\nfault), \"error\"/\"3\", \"severe\"/\"4\", \"none\"/\"5\"\n\n--verbose, -v\nReport all system messages. (Same as \"--report=1\".)\n\n--quiet, -q\nReport no system messages. (Same as \"--report=5\".)\n\n--halt=\nHalt execution at system messages at or above . Levels as in --report. De‐\nfault: 4 (severe).\n", "long": "--leave-comments" }, { "name": "--strict", "content": "Halt at the slightest problem. Same as \"--halt=info\".\n\n--exit-status=\nEnable a non-zero exit status for non-halting system messages at or above .\nDefault: 5 (disabled).\n", "long": "--strict" }, { "name": "--debug", "content": "Enable debug-level system messages and diagnostics.\n", "long": "--debug" }, { "name": "--no-debug", "content": "Disable debug output. (default)\n\n--warnings=\nSend the output of system messages to .\n", "long": "--no-debug" }, { "name": "--traceback", "content": "Enable Python tracebacks when Docutils is halted.\n", "long": "--traceback" }, { "name": "--no-traceback", "content": "Disable Python tracebacks. (default)\n\n--input-encoding=, -i \nSpecify the encoding and optionally the error handler of input text. Default: :strict.\n\n--input-encoding-error-handler=INPUTENCODINGERRORHANDLER\nSpecify the error handler for undecodable characters. Choices: \"strict\" (default),\n\"ignore\", and \"replace\".\n\n--output-encoding=, -o \nSpecify the text encoding and optionally the error handler for output. Default:\nUTF-8:strict.\n\n--output-encoding-error-handler=OUTPUTENCODINGERRORHANDLER\nSpecify error handler for unencodable output characters; \"strict\" (default), \"ignore\",\n\"replace\", \"xmlcharrefreplace\", \"backslashreplace\".\n\n--error-encoding=, -e \nSpecify text encoding and error handler for error output. Default text encoding: sys‐\ntem encoding. Default error handler: backslashreplace.\n\n--error-encoding-error-handler=ERRORENCODINGERRORHANDLER\nSpecify the error handler for unencodable characters in error output. Default: back‐\nslashreplace.\n\n--language=, -l \nSpecify the language (as BCP 47 language tag). Default: en.\n\n--record-dependencies=\nWrite output file dependencies to .\n\n--config=\nRead configuration settings from , if it exists.\n\n--version, -V\nShow this program's version number and exit.\n\n--help, -h\nShow this help message and exit.\n", "long": "--no-traceback" }, { "name": "Generic Parser Options", "content": "" }, { "name": "--no-file-insertion", "content": "Disable directives that insert the contents of an external file; replaced with a\n\"warning\" system message.\n", "long": "--no-file-insertion" }, { "name": "--file-insertion-enabled", "content": "Enable directives that insert the contents of an external file. (default)\n", "long": "--file-insertion-enabled" }, { "name": "--no-raw", "content": "Disable the \"raw\" directive; replaced with a \"warning\" system message.\n", "long": "--no-raw" }, { "name": "--raw-enabled", "content": "Enable the \"raw\" directive. (default)\n\n--line-length-limit=\nMaximal number of characters in an input line. Default 10 000.\n", "long": "--raw-enabled" }, { "name": "reStructuredText Parser Options", "content": "" }, { "name": "--pep-references", "content": "Recognize and link to standalone PEP references (like \"PEP 258\").\n\n--pep-base-url=\nBase URL for PEP references (default \"http://www.python.org/dev/peps/\").\n\n--pep-file-url-template=\nTemplate for PEP file part of URL. (default \"pep-%04d\")\n", "long": "--pep-references" }, { "name": "--rfc-references", "content": "Recognize and link to standalone RFC references (like \"RFC 822\").\n\n--rfc-base-url=\nBase URL for RFC references (default \"http://tools.ietf.org/html/\").\n\n--tab-width=\nSet number of spaces for tab expansion (default 8).\n", "long": "--rfc-references" }, { "name": "--trim-footnote-reference-space", "content": "Remove spaces before footnote references.\n", "long": "--trim-footnote-reference-space" }, { "name": "--leave-footnote-reference-space", "content": "Leave spaces before footnote references.\n\n--syntax-highlight=\nToken name set for parsing code with Pygments: one of \"long\", \"short\", or \"none\" (no\nparsing). Default is \"long\".\n\n--smart-quotes=\nChange straight quotation marks to typographic form: one of \"yes\", \"no\", \"alt[erna‐\ntive]\" (default \"no\").\n\n--smartquotes-locales=\nCharacters to use as \"smart quotes\" for .\n", "long": "--leave-footnote-reference-space" }, { "name": "--word-level-inline-markup", "content": "Inline markup recognized at word boundaries only (adjacent to punctuation or white‐\nspace). Force character-level inline markup recognition with \"\" (backslash + space).\nDefault.\n", "long": "--word-level-inline-markup" }, { "name": "--character-level-inline-markup", "content": "Inline markup recognized anywhere, regardless of surrounding characters. Backslash-es‐\ncapes must be used to avoid unwanted markup recognition. Useful for East Asian lan‐\nguages. Experimental.\n", "long": "--character-level-inline-markup" }, { "name": "Standalone Reader", "content": "" }, { "name": "--no-doc-title", "content": "Disable the promotion of a lone top-level section title to document title (and subse‐\nquent section title to document subtitle promotion; enabled by default).\n", "long": "--no-doc-title" }, { "name": "--no-doc-info", "content": "Disable the bibliographic field list transform (enabled by default).\n", "long": "--no-doc-info" }, { "name": "--section-subtitles", "content": "Activate the promotion of lone subsection titles to section subtitles (disabled by de‐\nfault).\n", "long": "--section-subtitles" }, { "name": "--no-section-subtitles", "content": "Deactivate the promotion of lone subsection titles.\n", "long": "--no-section-subtitles" }, { "name": "HTML-Specific Options", "content": "--template=\nSpecify the template file (UTF-8 encoded). Default is \"/usr/share/docutils/writ‐\ners/html5polyglot/template.t xt\".\n\n--stylesheet=\nComma separated list of stylesheet URLs. Overrides previous --stylesheet and\n--stylesheet-path settings.\n\n--stylesheet-path=\nComma separated list of stylesheet paths. Relative paths are expanded if a matching\nfile is found in the --stylesheet-dirs. With --link-stylesheet, the path is rewritten\nrelative to the output HTML file. Default: \"minimal.css,plain.css\"\n" }, { "name": "--embed-stylesheet", "content": "Embed the stylesheet(s) in the output HTML file. The stylesheet files must be acces‐\nsible during processing. This is the default.\n", "long": "--embed-stylesheet" }, { "name": "--link-stylesheet", "content": "Link to the stylesheet(s) in the output HTML file. Default: embed stylesheets.\n\n--stylesheet-dirs=\nComma-separated list of directories where stylesheets are found. Used by\n--stylesheet-path when expanding relative path arguments. Default: \"['.',\n'/usr/share/docutils/writers/html5polyglot']\"\n\n--initial-header-level=\nSpecify the initial header level. Default is 2 for \"

\". Does not affect document\ntitle & subtitle (see --no-doc-title).\n\n--footnote-references=\nFormat for footnote references: one of \"superscript\" or \"brackets\". Default is\n\"brackets\".\n\n--attribution=\nFormat for block quote attributions: one of \"dash\" (em-dash prefix), \"parenthe‐\nses\"/\"parens\", or \"none\". Default is \"dash\".\n", "long": "--link-stylesheet" }, { "name": "--compact-lists", "content": "Remove extra vertical whitespace between items of \"simple\" bullet lists and enumerated\nlists. Default: enabled.\n", "long": "--compact-lists" }, { "name": "--no-compact-lists", "content": "Disable compact simple bullet and enumerated lists.\n", "long": "--no-compact-lists" }, { "name": "--compact-field-lists", "content": "Remove extra vertical whitespace between items of simple field lists. Default: en‐\nabled.\n", "long": "--compact-field-lists" }, { "name": "--no-compact-field-lists", "content": "Disable compact simple field lists.\n", "long": "--no-compact-field-lists" }, { "name": "--embed-images", "content": "Embed images in the output HTML file, if the image files are accessible during pro‐\ncessing.\n", "long": "--embed-images" }, { "name": "--link-images", "content": "Link to images in the output HTML file. This is the default.\n\n--table-style=TABLESTYLE\nAdded to standard table classes. Defined styles: borderless, booktabs, align-left,\nalign-center, align- right, colwidths-auto. Default: \"\"\n\n--math-output=MATHOUTPUT\nMath output format (one of \"MathML\", \"HTML\", \"MathJax\", or \"LaTeX\") and option(s). De‐\nfault: \"HTML math.css\"\n", "long": "--link-images" }, { "name": "--xml-declaration", "content": "Prepend an XML declaration. (Thwarts HTML5 conformance.) Default: False\n", "long": "--xml-declaration" }, { "name": "--no-xml-declaration", "content": "Omit the XML declaration.\n", "long": "--no-xml-declaration" }, { "name": "--cloak-email-addresses", "content": "Obfuscate email addresses to confuse harvesters while still keeping email links usable\nwith standards- compliant browsers.\n\n\n\n\nRST2HTML5(1)", "long": "--cloak-email-addresses" } ] } } } }