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.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-ext-mystmd 0.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx_ext_mystmd-0.0.0.tar.gz | 9.4 kB | Without provenance | Details for sphinx_ext_mystmd-0.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_ext_mystmd-0.0.0-py3-none-any.whl | Python 3 | none | any | Details for sphinx_ext_mystmd-0.0.0-py3-none-any.whl |
Total release size: 17.6 kB
Release files / sphinx_ext_mystmd-0.0.0.tar.gz
| Download URL | sphinx_ext_mystmd-0.0.0.tar.gz |
|---|---|
| Size | 9.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
beba24e29784f6c16d3ce5c5fbbde429f280017fde242b771ffaaddc8b64639c
|
|
BLAKE2b-256 checksum How to use checksums |
169c6511b35a158f05fc5c91e27f5164a0420d1d293b31662ef0d96d2f06844a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.5
|
Release files / sphinx_ext_mystmd-0.0.0-py3-none-any.whl
| Download URL | sphinx_ext_mystmd-0.0.0-py3-none-any.whl |
|---|---|
| Size | 8.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b100b460ab99cd1b49b56376032cd3d793e474ce02aa085388567422499aecee
|
|
BLAKE2b-256 checksum How to use checksums |
7fbc647d83fbde1474cf6ab3d5e18bcba4cf76cac8127ebd660c6246bf088640
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.5
|
Security for sphinx-ext-mystmd 0.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
