{
    "mode": "man",
    "parameter": "rst-buildhtml",
    "section": "1",
    "url": "https://www.chedong.com/phpMan.php/man/rst-buildhtml/1/json",
    "generated": "2026-05-30T05:15:17Z",
    "synopsis": "rst-buildhtml [options] [<directory> ...]",
    "sections": {
        "NAME": {
            "content": "rst-buildhtml - convert many reST documents to HTML\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "rst-buildhtml [options] [<directory> ...]\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "Generates .html from all the reStructuredText .txt files (including PEPs) in each <directory>\n(default is the current directory).\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=<URL>\nUse <URL> 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=<class>\nRemove all elements with classes=\"<class>\" from the  document  tree.  Warning:  poten‐\ntially dangerous; use with caution. (Multiple-use option.)\n\n--strip-class=<class>\nRemove  all  classes=\"<class>\" attributes from elements in the document tree. Warning:\npotentially dangerous; use with caution. (Multiple-use option.)\n\n--report=<level>, -r <level>\nReport system messages at or higher than <level>: \"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=<level>\nHalt  execution  at  system messages at or above <level>.  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=<level>\nEnable a non-zero exit status for non-halting system messages  at  or  above  <level>.\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=<file>\nSend the output of system messages to <file>.\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=<name[:handler]>, -i <name[:handler]>\nSpecify  the  encoding  and optionally the error handler of input text.  Default: <lo‐\ncale-dependent>: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=<name[:handler]>, -o <name[:handler]>\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=<name[:handler]>, -e <name[:handler]>\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=<name>, -l <name>\nSpecify the language (as BCP 47 language tag).  Default: en.\n\n--record-dependencies=<file>\nWrite output file dependencies to <file>.\n\n--config=<file>\nRead configuration settings from <file>, 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": "PEP Reader Option Defaults",
                    "content": "The --pep-references and --rfc-references options (for the reStructuredText parser) are on by\ndefault.\n"
                },
                {
                    "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=<length>\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=<URL>\nBase URL for PEP references (default \"http://www.python.org/dev/peps/\").\n\n--pep-file-url-template=<URL>\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=<URL>\nBase URL for RFC references (default \"http://tools.ietf.org/html/\").\n\n--tab-width=<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=<format>\nToken  name  set for parsing code with Pygments: one of \"long\", \"short\", or \"none\" (no\nparsing). Default is \"long\".\n\n--smart-quotes=<yes/no/alt>\nChange straight quotation marks to typographic form: one of  \"yes\",  \"no\",  \"alt[erna‐\ntive]\" (default \"no\").\n\n--smartquotes-locales=<language:quotes[,language:quotes,...]>\nCharacters to use as \"smart quotes\" for <language>.\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": "HTML-Specific Options",
                    "content": "--template=<file>\nSpecify  the  template  file  (UTF-8  encoded).  Default is \"/usr/share/docutils/writ‐\ners/html4css1/template.txt\".\n\n--stylesheet=<URL[,URL,...]>\nComma  separated  list  of  stylesheet  URLs.  Overrides  previous  --stylesheet   and\n--stylesheet-path settings.\n\n--stylesheet-path=<file[,file,...]>\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: \"html4css1.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=<dir[,dir,...]>\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/html4css1',      '/usr/share/docutils/writers/html5poly‐\nglot']\"\n\n--initial-header-level=<level>\nSpecify  the initial header level.  Default is 1 for \"<h1>\".  Does not affect document\ntitle & subtitle (see --no-doc-title).\n\n--field-name-limit=<level>\nSpecify the maximum width (in characters) for one- column field names.   Longer  field\nnames  will span an entire row of the table used to render the field list.  Default is\n14 characters.  Use 0 for \"no limit\".\n\n--option-limit=<level>\nSpecify the maximum width (in characters) for options in option lists.  Longer options\nwill  span  an  entire row of the table used to render the option list.  Default is 14\ncharacters.  Use 0 for \"no limit\".\n\n--footnote-references=<format>\nFormat for footnote references:  one  of  \"superscript\"  or  \"brackets\".   Default  is\n\"brackets\".\n\n--attribution=<format>\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\". Default: \"\"\n\n--math-output=MATHOUTPUT\nMath  output  format,  one  of  \"MathML\", \"HTML\", \"MathJax\" or \"LaTeX\". Default: \"HTML\nmath.css\"\n",
                    "long": "--link-images"
                },
                {
                    "name": "--no-xml-declaration",
                    "content": "Omit the XML declaration.  Use with caution.\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",
                    "long": "--cloak-email-addresses"
                },
                {
                    "name": "PEP/HTML-Specific Options",
                    "content": "For   the   PEP/HTML   writer,   the  default  value  for  the  --stylesheet-path  option  is\n\"/usr/share/docutils/writers/pephtml/pep.css\", and  the  default  value  for  --template  is\n\"/usr/share/docutils/writers/pephtml/template.txt\". See HTML- Specific Options above.\n\n--python-home=<URL>\nPython's home URL.  Default is \"http://www.python.org\".\n\n--pep-home=<URL>\nHome URL prefix for PEPs.  Default is \".\" (current directory).\n"
                },
                {
                    "name": "Build-HTML Options",
                    "content": ""
                },
                {
                    "name": "--recurse",
                    "content": "Recursively scan subdirectories for files to process.  This is the default.\n",
                    "long": "--recurse"
                },
                {
                    "name": "--local",
                    "content": "Do not scan subdirectories for files to process.\n\n--prune=<directory>\nDo  not  process  files in <directory> (shell globbing patterns, separated by colons).\nThis option may be used more than once  to  specify  multiple  directories.   Default:\n\".hg:.bzr:.git:.svn:CVS\".\n\n--ignore=<patterns>\nRecursively  ignore files matching any of the given wildcard (shell globbing) patterns\n(separated by colons).\n\n--writer=<writer>\nDocutils writer, one of \"html\", \"html4\", \"html5\".  Default: \"html\" (use Docutils'  de‐\nfault HTML writer).\n\n--html-writer=<writer>\nObsoleted by \"--writer\".\n",
                    "long": "--local"
                },
                {
                    "name": "--silent",
                    "content": "Work silently (no progress messages).  Independent of \"--quiet\".\n",
                    "long": "--silent"
                },
                {
                    "name": "--dry-run",
                    "content": "Do not process files, show files that would be processed.\n\n\n\n\nRST-BUILDHTML(1)",
                    "long": "--dry-run"
                }
            ]
        }
    },
    "summary": "rst-buildhtml - convert many reST documents to HTML",
    "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=<URL> Use <URL> 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=<class> Remove all elements with classes=\"<class>\" from the document tree. Warning: poten‐ tially dangerous; use with caution. (Multiple-use option.) --strip-class=<class> Remove all classes=\"<class>\" attributes from elements in the document tree. Warning: potentially dangerous; use with caution. (Multiple-use option.) --report=<level>, -r <level> Report system messages at or higher than <level>: \"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=<level> Halt execution at system messages at or above <level>. 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=<level> Enable a non-zero exit status for non-halting system messages at or above <level>. 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=<file> Send the output of system messages to <file>."
        },
        {
            "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=<name[:handler]>, -i <name[:handler]> Specify the encoding and optionally the error handler of input text. Default: <lo‐ cale-dependent>:strict. --input-encoding-error-handler=INPUTENCODINGERRORHANDLER Specify the error handler for undecodable characters. Choices: \"strict\" (default), \"ignore\", and \"replace\". --output-encoding=<name[:handler]>, -o <name[:handler]> 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=<name[:handler]>, -e <name[:handler]> 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=<name>, -l <name> Specify the language (as BCP 47 language tag). Default: en. --record-dependencies=<file> Write output file dependencies to <file>. --config=<file> Read configuration settings from <file>, 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=<length> 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=<URL> Base URL for PEP references (default \"http://www.python.org/dev/peps/\"). --pep-file-url-template=<URL> 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=<URL> Base URL for RFC references (default \"http://tools.ietf.org/html/\"). --tab-width=<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=<format> Token name set for parsing code with Pygments: one of \"long\", \"short\", or \"none\" (no parsing). Default is \"long\". --smart-quotes=<yes/no/alt> Change straight quotation marks to typographic form: one of \"yes\", \"no\", \"alt[erna‐ tive]\" (default \"no\"). --smartquotes-locales=<language:quotes[,language:quotes,...]> Characters to use as \"smart quotes\" for <language>."
        },
        {
            "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": "--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=<dir[,dir,...]> Comma-separated list of directories where stylesheets are found. Used by --stylesheet-path when expanding relative path arguments. Default: \"['.', '/usr/share/docutils/writers/html4css1', '/usr/share/docutils/writers/html5poly‐ glot']\" --initial-header-level=<level> Specify the initial header level. Default is 1 for \"<h1>\". Does not affect document title & subtitle (see --no-doc-title). --field-name-limit=<level> Specify the maximum width (in characters) for one- column field names. Longer field names will span an entire row of the table used to render the field list. Default is 14 characters. Use 0 for \"no limit\". --option-limit=<level> Specify the maximum width (in characters) for options in option lists. Longer options will span an entire row of the table used to render the option list. Default is 14 characters. Use 0 for \"no limit\". --footnote-references=<format> Format for footnote references: one of \"superscript\" or \"brackets\". Default is \"brackets\". --attribution=<format> 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\". Default: \"\" --math-output=MATHOUTPUT Math output format, one of \"MathML\", \"HTML\", \"MathJax\" or \"LaTeX\". Default: \"HTML math.css\""
        },
        {
            "flag": "",
            "long": "--no-xml-declaration",
            "arg": null,
            "description": "Omit the XML declaration. Use with caution."
        },
        {
            "flag": "",
            "long": "--cloak-email-addresses",
            "arg": null,
            "description": "Obfuscate email addresses to confuse harvesters while still keeping email links usable with standards- compliant browsers."
        },
        {
            "flag": "",
            "long": "--recurse",
            "arg": null,
            "description": "Recursively scan subdirectories for files to process. This is the default."
        },
        {
            "flag": "",
            "long": "--local",
            "arg": null,
            "description": "Do not scan subdirectories for files to process. --prune=<directory> Do not process files in <directory> (shell globbing patterns, separated by colons). This option may be used more than once to specify multiple directories. Default: \".hg:.bzr:.git:.svn:CVS\". --ignore=<patterns> Recursively ignore files matching any of the given wildcard (shell globbing) patterns (separated by colons). --writer=<writer> Docutils writer, one of \"html\", \"html4\", \"html5\". Default: \"html\" (use Docutils' de‐ fault HTML writer). --html-writer=<writer> Obsoleted by \"--writer\"."
        },
        {
            "flag": "",
            "long": "--silent",
            "arg": null,
            "description": "Work silently (no progress messages). Independent of \"--quiet\"."
        },
        {
            "flag": "",
            "long": "--dry-run",
            "arg": null,
            "description": "Do not process files, show files that would be processed. RST-BUILDHTML(1)"
        }
    ],
    "examples": [],
    "see_also": []
}