From 0f8e58bfa2c266bc77ec6e59884d59ca015b146a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Al=C3=A1n=20Mu=C3=B1oz?= <amuoz@ed.ac.uk>
Date: Tue, 24 May 2022 16:26:10 +0100
Subject: [PATCH] add myst
---
docs/source/conf.py | 1 +
docs/source/index.rst | 6 ++++--
2 files changed, 5 insertions(+), 2 deletions(-)
diff --git a/docs/source/conf.py b/docs/source/conf.py
index b088f88f..ca8a393f 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -36,6 +36,7 @@ extensions = [
"sphinx.ext.autodoc", # Core library for html generation from docstrings
"sphinx.ext.autosummary", # Create neat summary tables
"numpydoc", # Play along with numpydoc format
+ "myst-parser", # Include markdown in rst files.
]
autosummary_generate = True # Turn on sphinx.ext.autosummary
diff --git a/docs/source/index.rst b/docs/source/index.rst
index fd8c5bde..40796fad 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -20,5 +20,7 @@ Summary
-----------
Readme File
-----------
-
-.. mdinclude:: ../../README.md
+Source:
+```{literalinclude} ../../README.md
+:language: md
+```
--
GitLab