Add markdown build support in sphinx (#1706)

Pushkarm029 · web-flow · commit 23d5710d2eee · 2024-06-08T18:24:06.000+10:00
diff --git a/Makefile b/Makefile
@@ -68,6 +68,10 @@ docs: docs-python docs-rust
 docs-python: install-just-deps-all
 	poetry run sphinx-build docs docs/build/html -b html
 
+.PHONY: docs-python-markdown
+docs-python-markdown: install-just-deps-all
+	poetry run sphinx-build -M markdown ./docs ./docs/build/markdown
+
 .PHONY: docs-rust
 docs-rust:
 	(cd nautilus_core && RUSTDOCFLAGS="--enable-index-page -Zunstable-options" cargo +nightly doc --all-features --no-deps --workspace --exclude tokio-tungstenite)
diff --git a/docs/conf.py b/docs/conf.py
@@ -32,6 +32,7 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
+    "sphinx_markdown_builder",
     "sphinx_togglebutton",
     "sphinx_copybutton",
     "sphinx_comments",
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -113,6 +113,7 @@ sphinx_copybutton = "^0.5.0"
 sphinx-external-toc = "^0.3.1"
 sphinx-material = "^0.0.35"
 sphinx_togglebutton = "^0.3.0"
+sphinx_markdown_builder = "^0.6.6"
 
 [tool.isort]  # Used by legacy isort for Cython modules
 py_version = "310"
