This page documents the sphinx configuration options that are available. All options are prepended with tomyst.
A list which takes the path of your static folders, relative to the project’s
It creates the directory structure of the path, inside the output directory:
and then copies over the files inside the given path.
For config variable:
tomyst_static_file_path = ["source/_static"]
the contents of this folder will be copied over to
Target Parser Configuration¶
Allows you to choose which parser to target for myst
The main difference between the two parser options is how
code is converted.
myst_nb executable code is contained
code-cell directives to enable compatibility with
and code execution.
In the future we would like to support
jupyter-book conversion directly
by constructing _config.yml and _toc.yml files.
tomyst_parser = 'myst_parser'
This option allows you to specify a custom jupytext header to support jupytext compatibility and execution using myst-nb
jupytext header is prepended to the top of every file.
Code and Execution¶
Allows you to specify the default programming language (Default: Python)
This is used to determine if
code-blocks should be included as executable
code-cells or not.
For a code-block that is different to the default programming language (or language synonym) then it
will be added to the generated myst file as display code only.
To set the default language to
julia you would add the following to
tomyst_default_language = "julia"
Allows you to specify multiple names for code that can be executed using the same jupyter kernel.
Generated (conf.py) Settings:¶
Enables the removal of blocks in the
conf.py using the following block tags.
These keys can be added as comments and anything between them will be removed.
The default value: False
No checks are implemented for
tomyst_conf_removeblocks = True
Enables the removal of a line in the
conf.py based on a pattern.
For example you may want to remove a current package during conversion
tomyst_conf_dropcontaining = "sphinxcontrib.jupyter"