This page was generated from doc/a-markdown-file.md. Interactive online version: . Download notebook.

Using Markdown Files

Sphinx on its own doesn’t know how to handle Markdown files, but there are extensions that enable their usage as Sphinx source files. For an example, see the Sphinx documentation.

Alternatively, when using nbsphinx it is also possible to use Markdown files via custom notebook formats.

You only need to install the jupytext package and add a configuration setting to conf.py, which can be used to select one of several Markdown flavors supported by jupytext (here we are using R Markdown):

nbsphinx_custom_formats = {
    '.md': ['jupytext.reads', {'fmt': 'Rmd'}],
}

This very page was generated from a Markdown file using these settings.

Links to Notebooks (and Other Sphinx Source Files)

Links to other Sphinx source files can be created like in Markdown cells of notebooks.

Math

Mathematical equations can be used just like in Markdown cells of notebooks.

Inline like this: \(\text{e}^{i\pi} = -1\).

Or as a separate block:

\begin{equation*} \int\limits_{-\infty}^\infty f(x) \delta(x - x_0) dx = f(x_0) \end{equation*}

Tables

A	B	A and B
False	False	False
True	False	False
False	True	False
True	True	True

Images