From 8bcdadf580c5c6e01c779171150509ca82274902 Mon Sep 17 00:00:00 2001 From: Stephan Heunis Date: Mon, 9 Oct 2023 15:36:25 +0200 Subject: [PATCH 1/2] add sphinx_copybutton extension to allow copying code in docs --- docs/source/conf.py | 1 + requirements-devel.txt | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/source/conf.py b/docs/source/conf.py index 930425ee..026805d5 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -71,6 +71,7 @@ 'sphinx.ext.inheritance_diagram', 'sphinx.ext.viewcode', 'sphinx.ext.napoleon', + 'sphinx_copybutton', ] # for the module reference diff --git a/requirements-devel.txt b/requirements-devel.txt index 364f811f..3481b6fe 100644 --- a/requirements-devel.txt +++ b/requirements-devel.txt @@ -4,3 +4,4 @@ pytest-cov coverage sphinx sphinx_rtd_theme +sphinx_copybutton From cde421e6eedceceb65bdf1b2c0491a377724d2a2 Mon Sep 17 00:00:00 2001 From: Stephan Heunis Date: Mon, 9 Oct 2023 15:40:32 +0200 Subject: [PATCH 2/2] adds descriptive comment to requirements --- requirements-devel.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/requirements-devel.txt b/requirements-devel.txt index 3481b6fe..57f5402f 100644 --- a/requirements-devel.txt +++ b/requirements-devel.txt @@ -2,6 +2,8 @@ pytest pytest-cov coverage + +# requirements for a document building sphinx sphinx_rtd_theme sphinx_copybutton