--- name: "mystnb-docutils-html5" section: "1" platform: "linux" package: "python3-myst-nb" version: "1.1.2-1" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/mystnb-docutils-html5" --- # mystnb-docutils-html5(1) mystnb-docutils-html5 ## NAME mystnb-docutils-html5 - mystnb-docutils-html5 ## DESCRIPTION Usage ===== - mystnb-docutils-html5 \[options\] \[\ \[\\]\] Generates HTML5 documents from standalone MyST Notebook sources. Reads from \ (default is stdin) and writes to \ (default is stdout). See https://docutils.sourceforge.io/docs/user/config.html for a detailed settings reference. External outputs are written to \`--nb-output-folder\`. Options ======= General Docutils Options **------------------------** **--output=**\ Output destination name. Obsoletes the \ - positional argument. Default: None (stdout). **--title=**\ Specify the document title as metadata. **--generator**, **-g** Include a "Generated by Docutils" credit and link. **--no-generator** 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). **--no-datestamp** Do not include a datestamp of any kind. **--root-prefix=**\ Base directory for absolute paths when reading from - the local filesystem. Default "/". **--source-link**, **-s** Include a "View document source" link. **--source-url=**\ Use \ for a source link; implies **--source-link**. **--no-source-link** Do not include a "View document source" link. **--toc-entry-backlinks** Link from section headers to TOC entries. (default) **--toc-top-backlinks** Link from section headers to the top of the TOC. **--no-toc-backlinks** Disable backlinks to the table of contents. **--footnote-backlinks** Link from footnotes/citations to references. (default) **--no-footnote-backlinks** - Disable backlinks from footnotes and citations. **--section-numbering** Enable section numbering by Docutils. (default) **--no-section-numbering** Disable section numbering by Docutils. **--strip-comments** Remove comment elements from the document tree. **--leave-comments** Leave comment elements in the document tree. (default) **--strip-elements-with-class=**\ - Remove all elements with classes="\" from the document tree. Warning: potentially 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" (default), "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**. Default: 4 (severe). **--strict** 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). **--debug** Enable debug-level system messages and diagnostics. **--no-debug** Disable debug output. (default) **--warnings=**\ Send the output of system messages to \. **--traceback** Enable Python tracebacks when Docutils is halted. **--no-traceback** Disable Python tracebacks. (default) **--input-encoding=**\, **-i** \ - Specify the encoding and optionally the error handler of input text. Default: \:strict. **--input-encoding-error-handler**=*INPUT\_ENCODING\_ERROR\_HANDLER* - 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**=*OUTPUT\_ENCODING\_ERROR\_HANDLER* - 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 encoding: system encoding. Default error handler: backslashreplace. **--error-encoding-error-handler**=*ERROR\_ENCODING\_ERROR\_HANDLER* - Specify the error handler for unencodable characters in error output. Default: backslashreplace. **--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. MyST-NB options **---------------** **--nb-read-as-md=**\ - Read as the MyST Markdown format (default: False) **--nb-metadata-key=**\ - Notebook level metadata key for config overrides (default: (default: 'mystnb')) **--nb-cell-metadata-key=**\ - Cell level metadata key for config overrides (default: (default: 'mystnb')) **--nb-eval-name-regex=**\ - Regex that matches permitted values of eval expressions (default: (default: '^\[a-zAZ\_\]\[a-zA-Z0-9\_\]\*$')) **--nb-execution-mode=**\<'off'\|'force'\|'auto'\|'cache'\|'inline'\> - Execution mode for notebooks (default: 'auto') **--nb-execution-cache-path=**\ - Path to folder for caching notebooks (default: \) (default: (default: '')) **--nb-execution-timeout=**\ - Execution timeout (seconds) (default: 30) **--nb-execution-in-temp=**\ - Use temporary folder for the execution current working directory (default: False) **--nb-execution-allow-errors=**\ - Allow errors during execution (default: False) **--nb-execution-raise-on-error=**\ - Raise an exception on failed execution, rather than emitting a warning (default: False) **--nb-execution-show-tb=**\ - Print traceback to stderr on execution error (default: False) **--nb-merge-streams=**\ - Merge stdout/stderr execution output streams (default: False) **--nb-render-plugin=**\ - The entry point for the execution output render class (in group \`myst\_nb.output\_renderer\`) (default: (default: 'default')) **--nb-remove-code-source=**\ - Remove code cell source (default: False) **--nb-remove-code-outputs=**\ - Remove code cell outputs (default: False) **--nb-code-prompt-show=**\ - Prompt to expand hidden code cell {content\|source\|outputs} (default: (default: 'Show code cell {type}')) **--nb-code-prompt-hide=**\ - Prompt to collapse hidden code cell {content\|source\|outputs} (default: (default: 'Hide code cell {type}')) **--nb-number-source-lines=**\ - Number code cell source lines (default: False) **--nb-builder-name=**\ - Builder name, to select render priority for mime types (default: (default: 'html')) **--nb-output-stderr=**\<'show'\|'remove'\|'remove-warn'\|'warn'\|'error'\|'severe'\> - Behaviour for stderr output (default: 'show') **--nb-render-text-lexer=**\ - Pygments lexer applied to stdout/stderr and text/plain outputs (default: (default: 'myst-ansi')) **--nb-render-error-lexer=**\ - Pygments lexer applied to error/traceback outputs (default: (default: 'ipythontb')) **--nb-render-markdown-format=**\<'commonmark'\|'gfm'\|'myst'\> - The format to use for text/markdown rendering (default: 'commonmark') **--nb-output-folder=**\ - Folder for external outputs (like images), skipped if empty (default: (default: 'build')) **--nb-append-css=**\ - Add default MyST-NB CSS to HTML outputs (default: True) **--nb-metadata-to-fm=**\ - Convert unhandled metadata to frontmatter (default: False) MyST options **------------** **--myst-commonmark-only=**\ - Use strict CommonMark parser (default: False) **--myst-gfm-only=**\ - Use strict Github Flavoured Markdown parser (default: False) **--myst-enable-extensions=**\ - Enable syntax extensions **--myst-disable-syntax=**\ - Disable Commonmark syntax elements **--myst-all-links-external=**\ - Parse all links as simple hyperlinks (default: False) **--myst-links-external-new-tab=**\ - Open all external links in a new tab (default: False) **--myst-url-schemes=**\\|\ - URI schemes that are converted to external links (default: http,https,mailto,ftp) **--myst-fence-as-directive=**\ - Interpret a code fence as a directive, for certain language names. This can be useful for fences like dot and mermaid, and interoperability with other Markdown renderers. **--myst-number-code-blocks=**\ - Add line numbers to code blocks with these languages **--myst-title-to-header=**\ - Convert a \`title\` field in the front-matter to a H1 header (default: False) **--myst-heading-anchors=**\ - Heading level depth to assign HTML anchors (default: 0\) **--myst-heading-slug-func=**\ - Function for creating heading anchors, or a python import path e.g. \`my\_package.my\_module.my\_function\` (default: (default: 'None')) **--myst-html-meta=**\ - HTML meta tags **--myst-footnote-sort=**\ - Move all footnotes to the end of the document, and sort by reference order (default: True) **--myst-footnote-transition=**\ - Place a transition before sorted footnotes (default: True) **--myst-words-per-minute=**\ - For reading speed calculations (default: 200) **--myst-substitutions=**\ - Substitutions mapping **--myst-linkify-fuzzy-links=**\ - Recognise URLs without schema prefixes (default: True) **--myst-dmath-allow-labels=**\ - Parse \`$$...$$ (label)\` (default: True) **--myst-dmath-allow-space=**\ - Allow initial/final spaces in \`$ ... $\` (default: True) **--myst-dmath-allow-digits=**\ - Allow initial/final digits \`1$ ...$2\` (default: True) **--myst-dmath-double-inline=**\ - Parse inline \`$$ ... $$\` (default: False) **--myst-enable-checkboxes=**\ - Enable checkboxes (default: False) **--myst-suppress-warnings=**\ - A list of warning types to suppress warning messages **--myst-highlight-code-blocks=**\ - Syntax highlight code blocks with pygments (default: True) **--myst-inventories=**\ - Mapping of key to (url, inv file), for intra-project referencing Generic Parser Options **----------------------** **--no-file-insertion** Disable directives that insert the contents of an - external file; replaced with a "warning" system message. **--file-insertion-enabled** - Enable directives that insert the contents of an external file. (default) **--no-raw** Disable the "raw" directive; replaced with a "warning" - system message. **--raw-enabled** Enable the "raw" directive. (default) **--line-length-limit=**\ - Maximal number of characters in an input line. Default 10 000. reStructuredText Parser Options **-------------------------------** **--pep-references** 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") **--rfc-references** 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). **--trim-footnote-reference-space** - Remove spaces before footnote references. **--leave-footnote-reference-space** - 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\[ernative\]" (default "no"). **--smartquotes-locales=**\ - Characters to use as "smart quotes" for \. **--word-level-inline-markup** - Inline markup recognized at word boundaries only (adjacent to punctuation or whitespace). Force character-level inline markup recognition with "\\ " (backslash + space). Default. **--character-level-inline-markup** - Inline markup recognized anywhere, regardless of surrounding characters. Backslash-escapes must be used to avoid unwanted markup recognition. Useful for East Asian languages. Experimental. Standalone Reader Options **-------------------------** **--no-doc-title** Disable the promotion of a lone top-level section - title to document title (and subsequent section title to document subtitle promotion; enabled by default). **--no-doc-info** Disable the bibliographic field list transform - (enabled by default). **--section-subtitles** Activate the promotion of lone subsection titles to - section subtitles (disabled by default). **--no-section-subtitles** Deactivate the promotion of lone subsection titles. HTML Writer Options **-------------------** **--template=**\ Template file. (UTF-8 encoded, default: "/usr/share/do - cutils/writers/html5\_polyglot/template.txt") **--stylesheet=**\ - Comma separated list of stylesheet URLs. Overrides previous **--stylesheet** and **--stylesheet-path** settings. **--stylesheet-path=**\ - Comma separated list of stylesheet paths. Relative paths are expanded if a matching file is found in the **--stylesheet-dirs**. With **--link-stylesheet**, the path is rewritten relative to the output HTML file. (default: "minimal.css,plain.css") **--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/html5\_polyglot") **--embed-stylesheet** Embed the stylesheet(s) in the output HTML file. The - stylesheet files must be accessible during processing. (default) **--link-stylesheet** 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: 2 for "\") **--footnote-references=**\ - Format for footnote references: one of "superscript" or "brackets". (default: "brackets") **--attribution=**\ Format for block quote attributions: one of "dash" - (em-dash prefix), "parentheses"/"parens", or "none". (default: "dash") **--compact-lists** Remove extra vertical whitespace between items of - "simple" bullet lists and enumerated lists. (default) **--no-compact-lists** Disable compact simple bullet and enumerated lists. **--compact-field-lists** Remove extra vertical whitespace between items of - simple field lists. (default) **--no-compact-field-lists** - Disable compact simple field lists. **--table-style**=*TABLE\_STYLE* - Added to standard table classes. Defined styles: borderless, booktabs, align-left, align-center, alignright, colwidths-auto, colwidths-grid. **--math-output**=*MATH\_OUTPUT* - Math output format (one of "MathML", "HTML", "MathJax", or "LaTeX") and option(s). (default: "HTML math.css") **--xml-declaration** Prepend an XML declaration. **--no-xml-declaration** Omit the XML declaration (default). **--cloak-email-addresses** - Obfuscate email addresses to confuse harvesters while still keeping email links usable with standardscompliant browsers. HTML5 Writer Options **--------------------** **--image-loading**=*IMAGE\_LOADING* - Suggest at which point images should be loaded: "embed", "link" (default), or "lazy". **--section-self-link** Append a self-link to section headings. **--no-section-self-link** Do not append a self-link to section headings. - (default)