A Sphinx extension to build MyST-MD AST from a Sphinx project
Project description
sphinx-ext-mystmd
A Sphinx extension to build MyST-MD AST from a Sphinx project. This can be used for:
- Embedding API documentation in a MyST project
- Providing MyST xref support for a deployed Sphinx project (gradual transition)
Add this extension to your conf.py
e.g.
extensions = ["sphinx_ext_mystmd"]
in order to be able to use the myst
builder, e.g.
sphinx-build -b myst . <BUILDDIR>
The generated .myst.json
files in <BUILDDIR>
can be added to your TOC e.g. using a pattern
entry, e.g.
project:
toc:
- file: index.md
- title: Sphinx Build
children:
- pattern: <BUILDDIR>/**.myst.json
You can also build an xref distribution for your site, which allows MyST projects to richly cross-reference into your documentation.
Running
sphinx-build -b myst-xref . <BUILDDIR>
will generate a myst.xref.json
in <BUILDDIR>
. The contents of <BUILDDIR>
should be added to your site's root directory.
[!WARNING] This extension is a literal work-in-progress; some things don't work. The intention is to get something on the page before we finalize it.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sphinx_ext_mystmd-0.0.0.tar.gz
.
File metadata
- Download URL: sphinx_ext_mystmd-0.0.0.tar.gz
- Upload date:
- Size: 9.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | beba24e29784f6c16d3ce5c5fbbde429f280017fde242b771ffaaddc8b64639c |
|
MD5 | 0330ac8744cd576df04814ddc1f8ec84 |
|
BLAKE2b-256 | 169c6511b35a158f05fc5c91e27f5164a0420d1d293b31662ef0d96d2f06844a |
Provenance
File details
Details for the file sphinx_ext_mystmd-0.0.0-py3-none-any.whl
.
File metadata
- Download URL: sphinx_ext_mystmd-0.0.0-py3-none-any.whl
- Upload date:
- Size: 8.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b100b460ab99cd1b49b56376032cd3d793e474ce02aa085388567422499aecee |
|
MD5 | 9112c5d214a59e0e69c5a8dc37aa760b |
|
BLAKE2b-256 | 7fbc647d83fbde1474cf6ab3d5e18bcba4cf76cac8127ebd660c6246bf088640 |