build: drop m2r2, use sphinx-mdinclude; also add missing doc devs

martibosch · Jan 2, 2025 · d0ea885 · d0ea885
1 parent d28814b
commit d0ea885
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -35,11 +35,11 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
-    "m2r2",
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
     "sphinx_click",
+    "sphinx_mdinclude",
     "sphinxcontrib.bibtex",
 ]
 bibtex_bibfiles = ["references.bib"]

diff --git a/docs/environment.yml b/docs/environment.yml
@@ -3,8 +3,8 @@ channels:
   - conda-forge
 dependencies:
   - lightgbm=4.5.0
-  - m2r2=0.3.3
   - pydata-sphinx-theme=0.16.1
   - sphinx=8.1.3
   - sphinx-click=6.0.0
+  - sphinx-mdinclude=0.6.2
   - sphinxcontrib-bibtex=2.6.3
diff --git a/pyproject.toml b/pyproject.toml
@@ -42,7 +42,7 @@ dependencies = [
 [project.optional-dependencies]
 test = ["coverage[toml]", "pytest", "pytest-cov", "ruff"]
 dev = ["build", "commitizen", "pre-commit", "pip", "toml", "tox", "twine"]
-doc = ["m2r2", "pydata-sphinx-theme", "sphinx"]
+doc = ["pydata-sphinx-theme", "sphinx", "sphinx-click", "sphinx-mdinclude", "sphinxcontrib-bibtex"]
 
 [project.scripts]
 detectree = "detectree.cli.main:cli"