#8534: Add sphinx-markdown-builder extension to docs build and add bu…

…ild directive in Make for it. Doesn't work yet because of liran-funaro/sphinx-markdown-builder#21
tenstorrent · May 22, 2024 · d6d8a20 · d6d8a20
1 parent b84ce16
commit d6d8a20
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -11,6 +11,7 @@ DOXYGENDIR    	= doxygen_build
 HTMLDIR       	= $(BUILDDIR)/html
 TT_METALIUM_BUILDDIR	= $(BUILDDIR)/tt-metalium
 TTNN_BUILDDIR	= $(BUILDDIR)/ttnn
+MARKDOWNDIR	= $(BUILDDIR)/markdown
 PORT          	?= 8888
 DOCS_VERSION       	?= latest
 
@@ -49,6 +50,10 @@ html: html/tt-metalium html/ttnn
 	mv -f $(TTNN_BUILDDIR) $(HTMLDIR)/ttnn
 	cp source/index.html $(HTMLDIR)/
 
+markdown: build_doxygen sphinx_build_dir
+	@DOCS_VERSION=$(DOCS_VERSION) REQUESTED_DOCS_PKG=tt-metalium $(SPHINXBUILD) -M markdown "$(SOURCEDIR)/tt-metalium" build/tt-metalium-md $(SPHINXOPTS) $(O)
+	@DOCS_VERSION=$(DOCS_VERSION) REQUESTED_DOCS_PKG=ttnn $(SPHINXBUILD) -M markdown "$(SOURCEDIR)/ttnn" build/ttnn-md $(SPHINXOPTS) $(O)
+
 ttnn_sweeps/check_directory:
 	@if [ -d "$(TTNN_SWEEPS_DIR)" ]; then \
 		echo "Error: ttnn sweeps dir $(TTNN_SWEEPS_DIR) exists already."; \

diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
@@ -8,3 +8,4 @@ nbsphinx==0.9.3
 sphinxcontrib-jquery==4.1
 ipython==8.12.3
 pandoc==2.3
+sphinx-markdown-builder==0.6.6
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -52,6 +52,7 @@
     "sphinxcontrib.email",
     "sphinx.ext.mathjax",
     "breathe",
+    "sphinx_markdown_builder",
 ]
 
 # Napoleon settings