Stack Overflow
Stack Overflow

Questions tagged [myst]

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.

30 questions
0
votes
1 answer

Adding only one entry to toctree for subdirectory

The toctree in the index.html page is one level deep when I expect it to be two levels deep. The project directory structure is like this: index.md dlg.md dlg/about/index.md dlg/... The dlg.md page looks like this (in MyST…
MakotoE
  • 1,814
  • 1
  • 20
  • 39
0
votes
2 answers

jupyterlab-myst: how to install or enable myst extension?

I am using jupyterlab-myst, a really cool extension. The MyST documentation on Topography mentions several extensions such as "attrs_block", "attrs_inline", "tasklist", "deflist", and "fieldlist". I believe those are MyST extensions, not JupyterLab…
user3651068
  • 3
  • 2
0
votes
0 answers

jupyterlab-myst: how to automatically popup tooltip when hovering over the footnote label?

I am using jupyterlab-myst, a really cool extension. The Footnotes section in MyST documentation has some examples. When I hover over the footnote label, the footnote definition together with the label automatically popup, like a tooltip. I copied…
user3651068
  • 3
  • 2
0
votes
2 answers

Is there a way in Sphinx Myst to link to a footnote in a different document?

I'm preparing documentation for a project using the Sphinx readthedocs theme and Myst. What I'd like to be able to do within a Myst file is to link to a footnote in another Myst file. For example, something like: See {ref}`Footnote %s…
William Seligman
  • 53
  • 4
0
votes
0 answers

Is it possible for Jupyter to automatically insert new lines?

In Kumar's answer to "How to wrap code/text in Jupyter notebooks" he provides a screenshot of Jupyter's word-wrapping options. These options are documented in the pull request Add wordWrapColumn and bounded line wrapping modes by AlbertHilb ·…
davidvandebunte
  • 1,286
  • 18
  • 25
0
votes
1 answer

Refering to a (sphynx autodoc generated) python method (:py:meth:) from a myst-parser markdown file?

I have a section of sphinx doc generated by the sphinx :autoclass: directive I want to refer to the (docstring) generated doc of a python method from a mystmarkdown file From I have tried this: {:py:meth:}the_module.TheClass.the_method but the…
Max L.
  • 9,774
  • 15
  • 56
  • 86
0
votes
0 answers

How to translate to MyST a reST configuration involving rst_prolog role, JS and CSS?

For a Sphinx-doc site, I'm trying to replicate with MyST a reStructuredText configuration involving rst_prolog role, JavaScript and CSS. But I'm a bit lost with roles and substitutions. Could someone help me to translate to MyST the following…
Denis Bitouzé
  • 520
  • 6
  • 18
0
votes
1 answer

Question about installation for Readthedocs and a related question about using markdown with the Sphinx for a RTD site

Please bear with me as I am a tech writer, not a developer. I actually have two questions, but they are related... Q1. We want to create a documentation project on GitHub and hosted in ReadTheDocs. If I understand correctly, to generate the…
user1682654
  • 55
  • 5
0
votes
0 answers

How to make Sphinx understand GFM tables in docstrings

VSCode can't render simple or grid-based reStructured tables in docstrings. It only understands GFM tables. However neither Napoleon nor MyST provide a way to parse them. MyST has a Python API, but I couldn't find out any way to hook a Sphinx event…
demberto
  • 489
  • 5
  • 15
0
votes
0 answers

Changing Labels on Sphinx html page

I am using myst-parser and autoapi to generate the html page for my src folder. Everything is working fine, except I can't seem to find an option to change the labels on the left menu other than changing the html files manually. I wonder if there is…
artodito
  • 25
  • 6
0
votes
1 answer

MyST allowing non-consecutive header level increase

I want to generate pages with a large header at the top but much smaller headers below. So for example

Big heading

Test

Small heading

test But if I go immediately from # Big Heading to #### Small heading I get this…
Barry
  • 1
  • 1
0
votes
0 answers

Is there a way to hide/remove MyST-specific syntax so a regular Markdown parser can be used?

I usually use ReST and Sphinx for generating documentation, but I'm dealing with a pre-existing Markdown system. I'd like to use MyST and Sphinx to generate documentation with references and autodoc, but make it available to the existing system as…
aviso
  • 2,371
  • 1
  • 14
  • 15
0
votes
1 answer

How can i use myst_parser with sphynx in readthedocs?

I can build the docs completely fine on my computer and open the HTML result and it looks great, but when I push to GitHub and read-the-docs tried to build it- I get the following error: root file…
aw1lt
  • 24
  • 1
  • 4
0
votes
1 answer

Sphinx Recommonmark CommonMarkParser does not detect URL link

I am using Sphinx to build a documentation out of Markdown files. The documentation is pretty clear that myst-parser should handle markdown links in the typical [some text](www.example.com) manner. Subsequently I installed myst-parser, set the…
Merk
  • 171
  • 12
0
votes
1 answer

How to change titles in a toctree using glob?

I use in my sphinx project a toctree with glob option and I want to show different titles than the H1 of my file or the name of the file with using Titlesonly as option of toctree. Here is a snap of my code : in the index.md there is README.md files…
BARIK FATI
  • 29
  • 9
1
2