Experimenting with sphinx_readme

tim-littlefair · tim-littlefair · commit 884e7b9da98b · 2025-11-26T08:17:32.000+08:00
diff --git a/docs/conf.py b/docs/conf.py
@@ -39,6 +39,7 @@
     "sphinx.ext.viewcode",  # Add links to highlighted source code
     "sphinx.ext.napoleon",  # to render Google format docstrings
     "sphinx.ext.githubpages",
+    "sphinx_readme",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,4 @@
 sphinx
 sphinx-copybutton
 sphinx-rtd-theme
+sphinx_readme

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@`
`39`	`39`	`"sphinx.ext.viewcode", # Add links to highlighted source code`
`40`	`40`	`"sphinx.ext.napoleon", # to render Google format docstrings`
`41`	`41`	`"sphinx.ext.githubpages",`
	`42`	`+ "sphinx_readme",`
`42`	`43`	`]`
`43`	`44`
`44`	`45`	`# Add any paths that contain templates here, relative to this directory.`