MyST is Markedly Structured Text, a fully-functional markdown flavor and parser for Sphinx.
MyST is Markedly Structured Text, a fully-functional markdown flavor and parser for Sphinx.
Questions tagged [myst]
30 questions
5
votes
3 answers
It is possible to have sphinx MyST rendering mermaid
It is possible to make work mermaid inside \.md file with MyST md driver ?
For now the only way I found is
$ tail conf.py
extensions = [ 'recommonmark', 'sphinxcontrib.mermaid']
from recommonmark.transform import AutoStructify
def setup(app):
…
user3313834
- 7,327
- 12
- 56
- 99
4
votes
1 answer
Sphinx - MySTParser - markdown : How to let some content appear on several pages?
We are writing a Sphinx doc with my team from markdown pages using myst-parser (https://myst-parser.readthedocs.io/en/latest/index.html), which is working quite well.
To avoid reduplication and improve maintenance, we would like to share content…
hajoki
- 77
- 4
3
votes
1 answer
How to specify index content/entries in Markdown?
Based on the Sphinx documentation, to specify various index entries (single entry, for example) in reStructuredText, like this:
.. index::
single: execution; context
The execution context
---------------------
...
When using Myst to do the same…
Igor Brejc
- 18,714
- 13
- 76
- 95
3
votes
0 answers
Force Sphinx to interpret Markdown with MyST in Python docstrings instead of reStructuredText
I'm rookie with Sphinx, and I was trying to figure out how to use MyST parser for sphinx to make it work with .autodoc extension.
I found this thread. I've been trying to convert this code to work with MyST and I failed.
I've been trying to do…
Rafal
- 83
- 5
3
votes
1 answer
Use substitution in Sphinx with MyST
MyST allows to write sphinx documentation in markdown.
Is it possible to combine it with substitutions?
M. Toya
- 615
- 8
- 24
2
votes
1 answer
How to import Markdown with Sphinx and myst-parser into Readthedocs?
In my docs/source/conf.py I have this code:
extensions = [
"sphinx.ext.autodoc",
"myst_parser",
]
source_suffix = ['.rst', '.md']
All my files are in Markdown, not in reStructuredText.
On ReadTheDocs, the initial build was successful…
ljyip
- 41
- 5
2
votes
0 answers
how to use vscode restructuredtext extension ( lextudio.restructuredtext) with myst-parser on markdown file?
I have a project configured to use Sphinx and the Myst-parser to build my documentation.
The build is fine and everything works (my conf.py in sphinx is OK).
Now, I use VSCode as an editor and I would like to have a "live preview" in vscode for my…
Mathias Rime
- 21
- 1
- 2
1
vote
0 answers
Sphinx add and refer to rendered markdown file
Lets say I have the following example project
root
| readme_sphinx_link.md
|
+---docs
| example.png
| readme.md
|
+---docs_sphinx
| | make.bat
| | Makefile
| |
| \---source
| | conf.py
| | …
stranger0612
- 301
- 1
- 2
- 12
1
vote
0 answers
What is the cause of the Sphinx warning "Block quote ends without a blank line; unexpected unindent" in a one line docstring
When I build my Sphinx HTML documentation, I get a warning.
checkdmarc.py:docstring of checkdmarc.BIMIRecordInWrongLocation:1: WARNING: Block quote ends without a blank line; unexpected unindent.
BIMIRecordInWrongLocation is a simple Exception…
Sean W.
- 4,944
- 8
- 40
- 66
1
vote
1 answer
Prevent MyST from changing .md image paths
I'm generating sphinx documentation with.md files that reference images via relative paths:
I use MyST to parse the .md files into html, but it removes the ../' making all paths:
_static/figures/image.png.
The…
Joshua von Damm
- 35
- 7
1
vote
1 answer
Sphinx admonitions not rendering properly
I am writing documentation using Sphinx and would like to include admonitions. An example shown is shown here for the Book theme: https://sphinx-book-theme.readthedocs.io/en/stable/reference/kitchen-sink/paragraph-markup.html#admonitions
However,…
atkat12
- 3,840
- 7
- 22
- 22
1
vote
1 answer
How to activate auto header generation in jupyter-book?
In my jupyter-book, I want to reference a section header in the same document using the syntax below:
I want to refer to [section](intro.md#how-to-learn-python]
where intro.md is your current markdown file, and how-to-learn-python is a section…
ilovewt
- 911
- 2
- 10
- 18
1
vote
2 answers
How to render Doxygen xml output into markdown instead of reST (using breathe or MyST-Parser)
I am preparing a project documentation using Sphinx where to fetch Doxygen XML output I have used breathe. I am using the breathe directive in .rst files.
sample.cpp
namespace X{
class A{
public:
int x;
};
}
in my rst file I just added
..…
user10634362
- 549
- 5
- 21
1
vote
0 answers
How to import/export myst markdown from emacs?
I've been starting to use jupyterbook and it comes with an interesting function called jupytext that can translate md to ipynb and vice versa. Since, I would like to be using emacs for md editing and jupyterbook requires myst flavor: is there a way…
jfmay
- 13
- 3
1
vote
0 answers
Why does Sphinx+MyST put spaces inside HTML tags in the generated output?
I'm new to MyST and Sphinx, so perhaps this has an obvious explanation, but it is not obvious to me. Whenever I use any construct in my Markdown source, such as bold facing or italics or even an html element such as , the result in the…
mhucka
- 2,143
- 26
- 41