{ "content": [ { "type": "text", "text": "# RST-BUILDHTML (man)\n\n## NAME\n\nrst-buildhtml - convert many reST documents to HTML View document source. Generated on: 2023-11-30 11:16 UTC. Generated by Docutils from reStructuredText source.\n\n## SYNOPSIS\n\nrst-buildhtml [options] [ ...]\n\n## DESCRIPTION\n\nGenerates .html from all the reStructuredText .txt files (including PEPs) in each \n(default is the current directory).\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (48 subsections)\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "RST-BUILDHTML", "section": "", "mode": "man", "summary": "rst-buildhtml - convert many reST documents to HTML View document source. Generated on: 2023-11-30 11:16 UTC. Generated by Docutils from reStructuredText source.", "synopsis": "rst-buildhtml [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 optionally error handler for error output. Default text en‐ coding: system 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 \"https://peps.python.org/\"). --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 \"https://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": "--embed-stylesheet", "arg": null, "description": "Embed the stylesheet(s) in the output HTML file. The stylesheet files must be acces‐ sible during processing. (default)" }, { "flag": "", "long": "--link-stylesheet", "arg": null, "description": "Link to the stylesheet(s) in the output HTML file. --initial-header-level= Specify the initial header level. Does not affect document title & subtitle (see --no-doc-title). (default: 1 for \"

\") --footnote-references= Format for footnote references: one of \"superscript\" or \"brackets\". (default: \"brack‐ ets\") --attribution= Format for block quote attributions: one of \"dash\" (em-dash prefix), \"parenthe‐ ses\"/\"parens\", or \"none\". (default: \"dash\")" }, { "flag": "", "long": "--compact-lists", "arg": null, "description": "Remove extra vertical whitespace between items of \"simple\" bullet lists and enumerated lists. (default)" }, { "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)" }, { "flag": "", "long": "--no-compact-field-lists", "arg": null, "description": "Disable compact simple field lists. --table-style=TABLESTYLE Added to standard table classes. Defined styles: borderless, booktabs, align-left, align-center, align- right, colwidths-auto, colwidths-grid. --math-output=MATHOUTPUT Math output format (one of \"MathML\", \"HTML\", \"MathJax\", or \"LaTeX\") and option(s). (default: \"HTML math.css\")" }, { "flag": "", "long": "--xml-declaration", "arg": null, "description": "Prepend an XML declaration (default)." }, { "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." }, { "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= Do not process files in (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= Recursively ignore files matching any of the given wildcard (shell globbing) patterns (separated by colons). --writer= Docutils writer, one of \"html\", \"html4\", \"html5\". Default: \"html\" (use Docutils' de‐ fault HTML 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": [], "section_outline": [ { "name": "NAME", "lines": 4, "subsections": [] }, { "name": "SYNOPSIS", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 3, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "General Docutils Options", "lines": 10 }, { "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": "PEP Reader Option Defaults", "lines": 3 }, { "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": "HTML Writer Options", "lines": 18 }, { "name": "--embed-stylesheet", "lines": 3, "long": "--embed-stylesheet" }, { "name": "--link-stylesheet", "lines": 14, "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": 2, "long": "--compact-field-lists" }, { "name": "--no-compact-field-lists", "lines": 10, "long": "--no-compact-field-lists" }, { "name": "--xml-declaration", "lines": 2, "long": "--xml-declaration" }, { "name": "--no-xml-declaration", "lines": 2, "long": "--no-xml-declaration" }, { "name": "--cloak-email-addresses", "lines": 3, "long": "--cloak-email-addresses" }, { "name": "HTML4 Writer Options", "lines": 10 }, { "name": "PEP/HTML Writer Options", "lines": 10 }, { "name": "Build-HTML Options", "lines": 1 }, { "name": "--recurse", "lines": 2, "long": "--recurse" }, { "name": "--local", "lines": 15, "long": "--local" }, { "name": "--silent", "lines": 2, "long": "--silent" }, { "name": "--dry-run", "lines": 4, "long": "--dry-run" } ] } ], "sections": { "NAME": { "content": "rst-buildhtml - convert many reST documents to HTML View document source. Generated on:\n2023-11-30 11:16 UTC. Generated by Docutils from reStructuredText source.\n\n", "subsections": [] }, "SYNOPSIS": { "content": "rst-buildhtml [options] [ ...]\n", "subsections": [] }, "DESCRIPTION": { "content": "Generates .html from all the reStructuredText .txt files (including PEPs) in each \n(default is the current directory).\n", "subsections": [] }, "OPTIONS": { "content": "", "subsections": [ { "name": "General Docutils Options", "content": "--output=\nOutput destination name. Obsoletes the positional argument. Default:\nNone (stdout).\n\n--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:\n<auto-detect>: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 optionally error handler for error output. Default text en‐\ncoding: system 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 \"https://peps.python.org/\").\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 \"https://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 Writer Options", "content": "--template=<file>\nTemplate file. (UTF-8 encoded, default: \"/usr/share/docutils/writers/html4css1/tem‐\nplate.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\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: \".,/usr/share/do‐\ncut ils/writers/html4css1,/usr/share/docutils/writers/html 5polyglot\")\n" }, { "name": "--embed-stylesheet", "content": "Embed the stylesheet(s) in the output HTML file. The stylesheet files must be acces‐\nsible during processing. (default)\n", "long": "--embed-stylesheet" }, { "name": "--link-stylesheet", "content": "Link to the stylesheet(s) in the output HTML file.\n\n--initial-header-level=<level>\nSpecify the initial header level. Does not affect document title & subtitle (see\n--no-doc-title). (default: 1 for \"<h1>\")\n\n--footnote-references=<format>\nFormat for footnote references: one of \"superscript\" or \"brackets\". (default: \"brack‐\nets\")\n\n--attribution=<format>\nFormat for block quote attributions: one of \"dash\" (em-dash prefix), \"parenthe‐\nses\"/\"parens\", or \"none\". (default: \"dash\")\n", "long": "--link-stylesheet" }, { "name": "--compact-lists", "content": "Remove extra vertical whitespace between items of \"simple\" bullet lists and enumerated\nlists. (default)\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)\n", "long": "--compact-field-lists" }, { "name": "--no-compact-field-lists", "content": "Disable compact simple field lists.\n\n--table-style=TABLESTYLE\nAdded to standard table classes. Defined styles: borderless, booktabs, align-left,\nalign-center, align- right, colwidths-auto, colwidths-grid.\n\n--math-output=MATHOUTPUT\nMath output format (one of \"MathML\", \"HTML\", \"MathJax\", or \"LaTeX\") and option(s).\n(default: \"HTML math.css\")\n", "long": "--no-compact-field-lists" }, { "name": "--xml-declaration", "content": "Prepend an XML declaration (default).\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", "long": "--cloak-email-addresses" }, { "name": "HTML4 Writer Options", "content": "--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" }, { "name": "PEP/HTML Writer 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 Writer Options above.\n\n--python-home=<URL>\nPython's home URL. Default is \"https://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", "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\nRST-BUILDHTML(1)", "long": "--dry-run" } ] } } } }