myst_parser.sphinx_ext.main

myst_parser.sphinx_ext.main#

The setup for the sphinx extension.

1.  Module Contents#

1.1.  Functions#

setup_sphinx

Initialize all settings and transforms in Sphinx.

create_myst_config

Create the myst config object and add it to the sphinx environment.

1.2.  API#

myst_parser.sphinx_ext.main.setup_sphinx(app: sphinx.application.Sphinx, load_parser: bool = False) None[source]#

Initialize all settings and transforms in Sphinx.

Parameters:
  • app – The Sphinx application object.

  • load_parser – Whether to load the parser.

myst_parser.sphinx_ext.main.create_myst_config(app)[source]#

Create the myst config object and add it to the sphinx environment.