summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2023-02-09 12:11:31 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2023-02-09 12:13:25 -0500
commit679555c53d9a0ff7ec3664e73871e380d77ae023 (patch)
treea634c78b5c3aed1b1c3277ae340e1a41de5b7d87
parent4fb3681f8167d8501ff8a348fd6e9caa6491122f (diff)
downloadalembic-679555c53d9a0ff7ec3664e73871e380d77ae023.tar.gz
pin sphinx-copybutton and change config
sphinx-copybutton introduced a new feature in 0.5.1 which includes a default configuration that breaks the regexp prompt matching scheme. set copybutton_exclude to not include ".gp" as that's the class where we exactly look for the prompts we are matching. pin sphinx-copybutton at 0.5.1 to avoid future problems. Change-Id: Ie03bc27a9190e71b63fc68b484f23e53b8cb72dc References: https://github.com/executablebooks/sphinx-copybutton/issues/185
-rw-r--r--docs/build/conf.py4
-rw-r--r--docs/build/requirements.txt2
2 files changed, 5 insertions, 1 deletions
diff --git a/docs/build/conf.py b/docs/build/conf.py
index 3100db9..ecd34da 100644
--- a/docs/build/conf.py
+++ b/docs/build/conf.py
@@ -45,6 +45,10 @@ copybutton_prompt_text = (
r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
)
copybutton_prompt_is_regexp = True
+# workaround
+# https://sphinx-copybutton-exclude-issue.readthedocs.io/en/v0.5.1-go/
+# https://github.com/executablebooks/sphinx-copybutton/issues/185
+copybutton_exclude = ".linenos"
# tags to sort on inside of sections
diff --git a/docs/build/requirements.txt b/docs/build/requirements.txt
index 2d7081c..6b2fd0e 100644
--- a/docs/build/requirements.txt
+++ b/docs/build/requirements.txt
@@ -6,4 +6,4 @@ python-dateutil
Mako
importlib-metadata;python_version<"3.8"
importlib-resources;python_version<"3.9"
-sphinx_copybutton
+sphinx_copybutton==0.5.1