Extend Sphinx Projects to Declare MyST References

Configure Your Project¶

The Sphinx conf.py for your project should include sphinx-ext-mystmd. If your Sphinx project lives in the working directory, then your conf.py might look like.

extensions = [
    "sphinx_ext_mystmd"
]
html_extra_path = ["./myst-xrefs"]

Build the MyST Metadata¶

sphinx-build -b myst-xref . ./myst-xrefs

Build the HTML Deployment¶

sphinx-build -b html . ./html

The published project now includes the xref information in the public directory.