From: Mike Bayer Date: Thu, 9 Feb 2023 17:05:47 +0000 (-0500) Subject: pin sphinx-copybutton and change config X-Git-Tag: rel_2_0_3~2 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=13d3b2c291f49525bc38d082d1c2abe9e03bd3fe;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git 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 --- diff --git a/doc/build/conf.py b/doc/build/conf.py index c8db935da1..443b7d3a29 100644 --- a/doc/build/conf.py +++ b/doc/build/conf.py @@ -53,6 +53,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 eccea8b182..9b9bffd36e 100644 --- a/doc/build/requirements.txt +++ b/doc/build/requirements.txt @@ -1,6 +1,6 @@ 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 +sphinx-copybutton==0.5.1 sphinx-autobuild typing-extensions