Skip to content

Commit

Permalink
docs: more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
agoose77 committed Aug 1, 2024
1 parent a63279e commit a784224
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 1 deletion.
32 changes: 32 additions & 0 deletions docs/extend-sphinx.md
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.
2 changes: 1 addition & 1 deletion docs/include-sphinx.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: Gradually upgrade Sphinx projects to the MyST engine through the My

The Sphinx `conf.py` for your project should include `sphinx-ext-mystmd`. If your Sphinx project lives under `sphinx`, then your `conf.py` might look like.
:::{code} python
:filename: conf.py
:filename: sphinx/conf.py

extensions = [
"sphinx_ext_mystmd"
Expand Down

0 comments on commit a784224

Please sign in to comment.