From ed54e62f94d78065a82df9424a29d9309d829ccc Mon Sep 17 00:00:00 2001 From: Zhi Ming Xu Date: Wed, 6 Aug 2025 15:40:00 -0400 Subject: [PATCH 1/3] chore: sync conf.py extensions with docs dependencies --- docs/source/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 48865a9b..de9a52bd 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -52,7 +52,7 @@ "sphinx.ext.intersphinx", "sphinx_rtd_theme", "sphinx_copybutton", - "m2r2", + "m2r", ] # Add any paths that contain templates here, relative to this directory. @@ -302,7 +302,7 @@ "diffpy.srfit Documentation", ab_authors, "diffpy.srfit", - "One line description of project.", + "Configurable code for solving atomic structures.", "Miscellaneous", ), ] From cd82cc8beee08c51a5275b57984eef473772f55d Mon Sep 17 00:00:00 2001 From: Zhi Ming Xu Date: Wed, 6 Aug 2025 15:40:33 -0400 Subject: [PATCH 2/3] chore: add news file --- news/update-docs-dependency.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 news/update-docs-dependency.rst diff --git a/news/update-docs-dependency.rst b/news/update-docs-dependency.rst new file mode 100644 index 00000000..f5a05916 --- /dev/null +++ b/news/update-docs-dependency.rst @@ -0,0 +1,23 @@ +**Added:** + +* No news added: Trivial change to conf.py + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +* From 75fd23a734e9cecf41b4028204d147f06ab655c6 Mon Sep 17 00:00:00 2001 From: Zhi Ming Xu Date: Wed, 6 Aug 2025 16:51:31 -0400 Subject: [PATCH 3/3] docs: use m2r2 instead of m2r in the sphinx extensions --- docs/source/conf.py | 2 +- requirements/docs.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index de9a52bd..dc17fe9b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -52,7 +52,7 @@ "sphinx.ext.intersphinx", "sphinx_rtd_theme", "sphinx_copybutton", - "m2r", + "m2r2", ] # Add any paths that contain templates here, relative to this directory. diff --git a/requirements/docs.txt b/requirements/docs.txt index 5f34c6ed..1de813f9 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -2,4 +2,4 @@ sphinx sphinx_rtd_theme sphinx-copybutton doctr -m2r +m2r2