From 2b7a2d63b418ac36fd4124b00e6a7a757980d334 Mon Sep 17 00:00:00 2001 From: Nik Kantar Date: Mon, 1 Jan 2024 12:03:46 -0800 Subject: [PATCH] Add sphinx-mdinclude --- docs/source/conf.py | 1 + pyproject.toml | 3 +++ 2 files changed, 4 insertions(+) diff --git a/docs/source/conf.py b/docs/source/conf.py index ceb0f14..ad04ed2 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -35,6 +35,7 @@ "sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx_rtd_theme", + "sphinx_mdinclude", ] # Add any paths that contain templates here, relative to this directory. diff --git a/pyproject.toml b/pyproject.toml index ece9a1e..3b06e79 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -48,6 +48,7 @@ python = "^3.9" # TODO not ideal, supporting 3.8 would be good # Docs sphinx = {version = "^7.2.6", optional = true} sphinx-rtd-theme = {version = "^2.0.0", optional = true} +sphinx-mdinclude = {version = "^0.5.3", optional = true} [tool.poetry.dev-dependencies] mypy = "^1.8.0" @@ -59,6 +60,7 @@ pytest-watch = "^4.2.0" coverage = "^7.4.0" pytest-cov = "^4.1.0" pdbpp = "^0.10.3" +sphinx-mdinclude = "^0.5.3" # Docs # NOTE: Please also add to: @@ -71,6 +73,7 @@ sphinx-rtd-theme = "^2.0.0" docs = [ "sphinx", "sphinx-rtd-theme", + "sphinx-mdinclude", ] [build-system]