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.
While we're there, use this new feature to exclude our sql
styles, even though this is not strictly necessary in our case.

pin sphinx-copybutton at 0.5.1 to avoid future problems.

Change-Id: I8eaeab13995c032b9ee3afd1f08dae5929009d45
References: https://github.com/executablebooks/sphinx-copybutton/issues/185
(cherry picked from commit 13d3b2c291f49525bc38d082d1c2abe9e03bd3fe)

diff --git a/doc/build/conf.py b/doc/build/conf.py
index 7c51ff06133b1e38d210c8775cc0061fcad549c5..d07758fc0550323d1a6f2a061fc0a57b57c954ea 100644 (file)
--- a/doc/build/conf.py
+++ b/doc/build/conf.py
@@ -51,6 +51,12 @@ copybutton_prompt_text = (
 )
 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
+# while we're at it, add our SQL css classes to also not be copied
+copybutton_exclude = ".linenos .show_sql .show_sql_print .popup_sql"
+
 nitpicky = False
 
 # The suffix of source filenames.

diff --git a/doc/build/requirements.txt b/doc/build/requirements.txt
index c5871d2124187b6463855e59bfcaec32f1a71780..6588bf3665d4cdba76915f428ec86857f39f97fe 100644 (file)
--- a/doc/build/requirements.txt
+++ b/doc/build/requirements.txt
@@ -1,4 +1,4 @@
 git+https://github.com/sqlalchemyorg/changelog.git#egg=changelog
 git+https://github.com/sqlalchemyorg/sphinx-paramlinks.git#egg=sphinx-paramlinks
 git+https://github.com/sqlalchemyorg/zzzeeksphinx.git#egg=zzzeeksphinx
-sphinx-copybutton
\ No newline at end of file
+sphinx-copybutton==0.5.1