Welcome to sphinx-tomyst’s documentation!¶
sphinx-tomyst is a Sphinx extension that enables projects to be converted to a myst project.
Myst files can be compiled using:
Jupyter Book (requires manual configuration)
sphinx-tomyst is currently built to target myst_nb
by default but for static projects you can also target
myst_parser using the
Step 1: To install the extension you need to clone the repository then run:
python setup.py install
Step 2: Add
sphinx_tomyst to your sphinx
extensions in the
Step 3: Build using
A `pypi release<https://github.com/QuantEcon/sphinx-tomyst/issues/75>`__ is coming once an alpha milestone is reached.