MYSTNB-DOCUTILS-LATEX(1)

🎀 MYSTNB-DOCUTILS-LATEX(1) 🎀

okay bestie, you've landed in User Commands and this is the manual page for mystnb-docutils-latex — grab a lil snack, we're doing this together 💖

---

💜 NAME 💜

mystnb-docutils-latex — and honestly the description is also just mystnb-docutils-latex. iconic, no notes 👑

---

🦋 DESCRIPTION 🦋

✨ Usage ✨

mystnb-docutils-latex [options] [<source> [<destination>]]

So here's the vibe: this thing generates LaTeX documents from standalone MyST Notebook sources ✨. It reads from <source> — and if you don't hand it one, default is stdin — and writes to <destination>, and if you don't hand it that, default is stdout.

Want the full settings reference? Literally go read https://docutils.sourceforge.io/docs/user/config.html, it has everything in detail, iykyk 📖

External outputs get written to --nb-output-folder, noted 🫶

🌸 Options 🌸

🎀 General Docutils Options 🎀

• --output-path=<destination>, --output=<destination> — the output destination name, periodt. This obsoletes the <destination> positional argument, so like… pick a lane bestie. Default: None (stdout).
• --title=<title> — sets the document title as metadata 🏷️
• --generator, -g — includes a "Generated by Docutils" credit and link, give credit where it's due 💅
• --no-generator — do not include a generator credit, humble era 🙈
• --date, -d — include the date at the end of the document (UTC) 📅
• --time, -t — include the time & date (UTC) ⏰
• --no-datestamp — no datestamp of any kind, we're timeless ✨
• --root-prefix=<path> — base directory for absolute paths when reading from the local filesystem. Default "".
• --source-link, -s — includes a "View document source" link 🔗
• --source-url=<URL> — use <URL> for a source link; this implies --source-link.
• --no-source-link — do not include a "View document source" link, hidden source era 🙈
• --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 entirely, no take-backs 💀
• --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=<class> — remove all elements with classes="<class>" from the document tree. ⚠️ Warning: potentially 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.)

bestie those last two are lowkey spicy — "potentially dangerous" is right there in the docs, so use with caution, fr fr 🫶

• --report=<level>, -r <level> — report system messages at or higher than <level>, and the levels go: "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=<level> — halt execution at system messages at or above <level>. Levels as in --report. Default: 4 (severe) 🛑
• --strict — halt at the slightest problem. Same as "--halt=info". she does NOT play 😭
• --exit-status=<level> — enable a non-zero exit status for non-halting system messages at or above <level>. Default: 5 (disabled).
• --debug — enable debug-level system messages and diagnostics 🐛
• --no-debug — disable debug output. (default)
• --warnings=<file> — send the output of system messages to <file> 📝
• --traceback — enable Python tracebacks when Docutils is halted 🐍
• --no-traceback — disable Python tracebacks. (default)
• --input-encoding=<name[:handler]> — specify the encoding and optionally the error handler of input text. Default: utf-8.
• --output-encoding=<name[:handler]> — specify the text encoding and optionally the error handler for output. Default: utf-8.
• --error-encoding=<name[:handler]>, -e <name[:handler]> — specify text encoding and optionally the error handler for error output. Default: system encoding.
• --language=<tag>, -l <tag> — 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 🆘

---

🦋 MyST-NB options 🦋

• --nb-read-as-md=<boolean> — read as the MyST Markdown format (default: False)
• --nb-metadata-key=<str> — notebook level metadata key for config overrides (default: (default: 'mystnb'))
• --nb-cell-metadata-key=<str> — cell level metadata key for config overrides (default: (default: 'mystnb'))
• --nb-eval-name-regex=<str> — regex that matches permitted values of eval expressions (default: (default: '^[a-zAZ_][a-zA-Z0-9_]*$')) — yes, that's a-zAZ, we copy exactly, don't come for me 💀
• --nb-execution-mode=<'off'|'force'|'auto'|'cache'|'inline'> — execution mode for notebooks (default: 'auto') ⚙️
• --nb-execution-cache-path=<str> — path to folder for caching notebooks (default: <outdir>) (default: (default: '')) — the doubled default is genuinely what it says, iykyk 🙈
• --nb-execution-timeout=<int> — execution timeout (seconds) (default: 30) ⏳
• --nb-execution-in-temp=<boolean> — use temporary folder for the execution current working directory (default: False)
• --nb-execution-allow-errors=<boolean> — allow errors during execution (default: False)
• --nb-execution-raise-on-error=<boolean> — raise an exception on failed execution, rather than emitting a warning (default: False) 😤
• --nb-execution-show-tb=<boolean> — print traceback to stderr on execution error (default: False)
• --nb-merge-streams=<boolean> — merge all stdout execution output streams; same with stderr (default: False) 🌊
• --nb-render-plugin=<str> — the entry point for the execution output render class (in group myst_nb.output_renderer) (default: (default: 'default'))
• --nb-remove-code-source=<boolean> — remove code cell source (default: False)
• --nb-remove-code-outputs=<boolean> — remove code cell outputs (default: False)
• --nb-scroll-outputs=<boolean> — make long cell outputs scrollable (default: False) 📜
• --nb-code-prompt-show=<str> — prompt to expand hidden code cell {content|source|outputs} (default: (default: 'Show code cell {type}'))
• --nb-code-prompt-hide=<str> — prompt to collapse hidden code cell {content|source|outputs} (default: (default: 'Hide code cell {type}'))
• --nb-number-source-lines=<boolean> — number code cell source lines (default: False) 🔢
• --nb-builder-name=<str> — 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=<str> — Pygments lexer applied to stdout/stderr and text/plain outputs (default: (default: 'myst-ansi'))
• --nb-render-error-lexer=<str> — 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=<str> — folder for external outputs (like images), skipped if empty (default: (default: 'build')) 📁
• --nb-append-css=<boolean> — add default MyST-NB CSS to HTML outputs (default: True) 🎨
• --nb-metadata-to-fm=<boolean> — convert unhandled metadata to frontmatter (default: False)

---

🌈 MyST options 🌈

• --myst-commonmark-only=<boolean> — use strict CommonMark parser (default: False)
• --myst-gfm-only=<boolean> — use strict Github Flavoured Markdown parser (default: False)
• --myst-enable-extensions=<comma-delimited> — enable syntax extensions ✨
• --myst-disable-syntax=<comma-delimited> — disable Commonmark syntax elements 🚫
• --myst-all-links-external=<boolean> — parse all links as simple hyperlinks (default: False)
• --myst-links-external-new-tab=<boolean> — open all external links in a new tab (default: False) 🪟
• --myst-url-schemes=<comma-delimited>|<yaml-dict> — URI schemes that are converted to external links (default: http,https,mailto,ftp)
• --myst-fence-as-directive=<comma-delimited> — 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=<comma-delimited> — add line numbers to code blocks with these languages 🔢
• --myst-title-to-header=<boolean> — convert a title field in the front-matter to a H1 header (default: False)
• --myst-heading-anchors=<int> — heading level depth to assign HTML anchors (default: 0) ⚓
• --myst-heading-slug-func=<str> — function for creating heading anchors, or a python import path e.g. my_package.my_module.my_function (default: (default: 'None'))
• --myst-html-meta=<yaml-dict> — HTML meta tags 🏷️
• --myst-footnote-sort=<boolean> — move all footnotes to the end of the document, and sort by reference order (default: True)
• --myst-footnote-transition=<boolean> — place a transition before sorted footnotes (default: True)
• --myst-words-per-minute=<int> — for reading speed calculations (default: 200) 📖
• --myst-substitutions=<yaml-dict> — substitutions mapping 🔁
• --myst-linkify-fuzzy-links=<boolean> — recognise URLs without schema prefixes (default: True)
• --myst-dmath-allow-labels=<boolean> — parse $$...$$ (label) (default: True)
• --myst-dmath-allow-space=<boolean> — allow initial/final spaces in $ ... $ (default: True)
• --myst-dmath-allow-digits=<boolean> — allow initial/final digits 1$ ...$2 (default: True)
• --myst-dmath-double-inline=<boolean> — parse inline $$ ... $$ (default: False)
• --myst-enable-checkboxes=<boolean> — enable checkboxes (default: False) ☑️
• --myst-suppress-warnings=<comma-delimited> — a list of warning types to suppress warning messages 🤫
• --myst-highlight-code-blocks=<boolean> — syntax highlight code blocks with pygments (default: True) 🌈
• --myst-inventories=<yaml-dict> — 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 — turns on directives that insert the contents of an external file. (default) ✨
• --no-raw — disables the "raw" directive; it gets swapped for a "warning" system message. lowkey a safety vibe.
• --raw-enabled — turns the "raw" directive back on. (default)
• --line-length-limit=<length> — maximal number of characters in an input line. default is 10 000. no cap, that's a lot.
• --validate — validate the document tree after parsing. self-care for your doc tree 💅
• --no-validation — do not validate the document tree. (default)

---

🦋 reStructuredText Parser Options 🦋

• --pep-references — recognize and link to standalone PEP references (like "PEP 258").
• --pep-base-url=<URL> — base URL for PEP references (default "https://peps.python.org/").
• --pep-file-url-template=<URL> — 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=<URL> — base URL for RFC references (default "https://tools.ietf.org/html/").
• --tab-width=<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=<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[ernative]" (default "no").
• --smartquotes-locales=<language:quotes[,language:quotes,...]> — characters to use as "smart quotes" for <language>.
• --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.

---

🎀 LaTeX-Specific Options 🎀

• --documentclass=<documentclass> — specify LaTeX documentclass. Default: "article".
• --documentoptions=<options> — specify document options. Multiple options can be given, separated by commas. Default: "a4paper".
• --footnote-references=<format> — format for footnote references: one of "superscript" or "brackets". Default: "superscript".
• --use-latex-citations — use \cite command for citations. (future default)
• --figure-citations — use figure floats for citations (might get mixed with real figures). (provisional default)
• --attribution=<format> — format for block quote attributions: one of "dash" (em-dash prefix), "parentheses"/"parens", or "none". Default: "dash".
• --stylesheet=<file[,file,...]> — specify LaTeX packages/stylesheets. A style is referenced with \usepackage if extension is ".sty" or omitted and with \input else. Overrides previous --stylesheet and --stylesheet-path settings.
• --stylesheet-path=<file[,file,...]> — comma separated list of LaTeX packages/stylesheets. Relative paths are expanded if a matching file is found in the --stylesheet-dirs. With --linkstylesheet, the path is rewritten relative to the output *.tex file.
• --link-stylesheet — link to the stylesheet(s) in the output file. (default)
• --embed-stylesheet — embed the stylesheet(s) in the output file. Stylesheets must be accessible during processing.
• --stylesheet-dirs=<dir[,dir,...]> — comma-separated list of directories where stylesheets are found. Used by --stylesheet-path when expanding relative path arguments. Default: ".".
• --latex-preamble=<preamble> — customization by LaTeX code in the preamble. Default: select PDF standard fonts (Times, Helvetica, Courier).
• --template=<file> — specify the template file. Default: "default.tex".
• --use-latex-toc — table of contents by LaTeX. (default)
• --use-docutils-toc — table of contents by Docutils (without page numbers).
• --use-part-section — add parts on top of the section hierarchy.
• --use-docutils-docinfo — attach author and date to the document info table. (default)
• --use-latex-docinfo — attach author and date to the document title.
• --topic-abstract — typeset abstract as topic. (default)
• --use-latex-abstract — use LaTeX abstract environment for the document's abstract.
• --hyperlink-color=<color> — color of any hyperlinks embedded in text. Default: "blue" (use "false" to disable).
• --hyperref-options=<options> — additional options to the "hyperref" package.
• --compound-enumerators — enable compound enumerators for nested enumerated lists (e.g. "1.2.a.ii").
• --no-compound-enumerators — disable compound enumerators for nested enumerated lists. (default)
• --section-prefix-for-enumerators — enable section ("." subsection ...) prefixes for compound enumerators. This has no effect without --compound-enumerators.
• --no-section-prefix-for-enumerators — disable section prefixes for compound enumerators. (default)
• --section-enumerator-separator=<char> — set the separator between section number and enumerator for compound enumerated lists. Default: "-".
• --literal-block-env=<environment> — when possible, use the specified environment for literal-blocks. Default: "" (fall back to "alltt").
• --table-style=<format> — table style. "standard" with horizontal and vertical lines, "booktabs" (LaTeX booktabs style) only horizontal lines above and below the table and below the header, or "borderless". Default: "standard"
• --graphicx-option=<option> — LaTeX graphicx package option. Default: "".
• --font-encoding=<encoding> — LaTeX font encoding. Possible values are "", "T1" (default), "OT1", "LGR,T1" or any other combination of options to the fontenc package.
• --reference-label=<command name> — per default the latex-writer puts the reference title into hyperreferences. Specify "ref" or "pageref" to get the section number or the page number.
• --use-bibtex=<style,bibfile[,bibfile,...]> — specify style and database(s) for bibtex, for example "--use-bibtex=unsrt,mydb1,mydb2". Provisional!
• --legacy-class-functions — use legacy functions with class value list for \DUtitle and \DUadmonition.
• --new-class-functions — use \DUrole and "DUclass" wrappers for class values. Place admonition content in an environment. (default)
• --legacy-column-widths — use legacy algorithm to determine table column widths. (provisional default)
• --new-column-widths — use new algorithm to determine table column widths. (future default)
• --docutils-footnotes — footnotes with numbers/symbols by Docutils. (default) (The alternative, --latex-footnotes, is not implemented yet.)

---

💖 that's the teaaa, bestie: source/version is debian, date is January 2026, and the page is MYSTNB-DOCUTILS-LATEX(1). periodt. 💖