feat: Include README.md in Sphinx documentation with myst-parser

2024-10-16 10:52:35 -03:00 · 2024-10-16 10:52:35 -03:00 · b61a389b92
parent 14c3358e81
commit b61a389b92
2 changed files with 1 additions and 1 deletions
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@ -21,6 +21,7 @@ latex_logo_width = '5cm'
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

 extensions = [
+    "myst_parser",
    "sphinx.ext.duration",
    "sphinx.ext.doctest",
    "sphinx.ext.autodoc",
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@ -10,7 +10,6 @@ Welcome to spiri-sdk's documentation!
   :maxdepth: 2
   :caption: Contents:

-
 .. include:: ../../README.md

 Indices and tables