-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
33 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
title: Extend Sphinx Projects to Declare MyST References | ||
subtitle: Add richer integration between existing Sphinx projects and the MyST ecosystem | ||
short_title: Reference from MyST | ||
description: Add richer integration between existing Sphinx projects and the MyST ecosystem by declaring MyST xref information | ||
--- | ||
|
||
## 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. | ||
:::{code} python | ||
:filename: conf.py | ||
|
||
extensions = [ | ||
"sphinx_ext_mystmd" | ||
] | ||
html_extra_path = ["./myst-build"] | ||
::: | ||
|
||
## Build the MyST Metadata | ||
|
||
```shell | ||
sphinx-build -b myst . ./myst-build | ||
``` | ||
|
||
## Build the HTML Deployment | ||
|
||
```shell | ||
sphinx-build -b html . ./html | ||
``` | ||
|
||
The published project now includes the xref information in the public directory. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters