Spiri
/
spiri-sdk
12
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases 1 Wiki Activity

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

This commit is contained in:
Alex Davies 2024-10-16 10:52:35 -03:00
parent 14c3358e81
commit b61a389b92
2 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/source/conf.py
View File

@ -21,6 +21,7 @@ latex_logo_width = '5cm'
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [ extensions = [
"myst_parser",
"sphinx.ext.duration", "sphinx.ext.duration",
"sphinx.ext.doctest", "sphinx.ext.doctest",
"sphinx.ext.autodoc", "sphinx.ext.autodoc",

1
docs/source/index.rst
View File

@ -10,7 +10,6 @@ Welcome to spiri-sdk's documentation!
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
.. include:: ../../README.md .. include:: ../../README.md
Indices and tables Indices and tables