Skip to content

Commit

Permalink
myst works but not with mermaid
Browse files Browse the repository at this point in the history
probably related to
executablebooks/MyST-Parser#742
and
executablebooks/MyST-Parser#366 and needing

```{mermaid}

instead of the usual

```mermaid

that renders in GitHub, Typora, etc.
  • Loading branch information
endolith committed Apr 29, 2023
1 parent 176c2e5 commit 62c60bf
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 9 deletions.
8 changes: 1 addition & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
extensions = [
'sphinx.ext.autodoc',
'numpydoc',
'm2r2',
'myst_parser',
'sphinxcontrib.mermaid',
]

Expand Down Expand Up @@ -63,12 +63,6 @@
'.md': 'markdown',
}

# Map the markdown files to the m2r2 parser
source_parsers = {
'.md': 'm2r2.parser.M2RParser',
}


# Copy ./examples/results images into documentation so they show up when
# markdown files with relative paths are transcluded (suggested by ChatGPT-4)
import os
Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Welcome to elsim's documentation!
:maxdepth: 2
:caption: Contents:

.. mdinclude:: ../README.md

.. include:: ../README.md
:parser: myst_parser.sphinx_


Indices and tables
Expand Down

0 comments on commit 62c60bf

Please sign in to comment.