diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2023-02-09 12:05:47 -0500 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2023-02-09 12:10:04 -0500 |
| commit | 072be3bf3529b1267dc96f16178be8a51a21b0ab (patch) | |
| tree | 0f502fccd08ef03bb5d6499ae6aa05d577fbde94 | |
| parent | 84fbfb0cb33f89e51ba223596f9a4dcebd822a99 (diff) | |
| download | sqlalchemy-rel_1_3.tar.gz | |
pin sphinx-copybutton and change configrel_1_3
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)
(cherry picked from commit faa20b16590c1a0b10817d3828cf479a906aebda)
| -rw-r--r-- | doc/build/conf.py | 6 | ||||
| -rw-r--r-- | doc/build/requirements.txt | 2 |
2 files changed, 7 insertions, 1 deletions
diff --git a/doc/build/conf.py b/doc/build/conf.py index 909032c71..dc85b6168 100644 --- 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 c5871d212..6588bf366 100644 --- 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 |