Skip to content

MAINT use sphinx-copybutton extension #1005

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 7, 2023
Merged

MAINT use sphinx-copybutton extension #1005

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions build_tools/circle/build_doc.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ mamba create -n $CONDA_ENV_NAME --yes --quiet \
"$(get_dep sphinx-gallery $SPHINX_GALLERY_VERSION)" \
"$(get_dep numpydoc $NUMPYDOC_VERSION)" \
"$(get_dep sphinxcontrib-bibtex $SPHINXCONTRIB_BIBTEX_VERSION)" \
"$(get_dep sphinx-copybutton $SPHINXCONTRIB_BIBTEX_VERSION)" \
"$(get_dep pydata-sphinx-theme $PYDATA_SPHINX_THEME_VERSION)" \
memory_profiler packaging seaborn pytest coverage compilers tensorflow

Expand Down
6 changes: 5 additions & 1 deletion doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,13 @@
"numpydoc",
"sphinx_issues",
"sphinx_gallery.gen_gallery",
"sphinx_copybutton",
]

# Specify how to identify the prompt when copying code snippets
copybutton_prompt_text = r">>> |\.\.\. "
copybutton_prompt_is_regexp = True

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

Expand Down Expand Up @@ -329,5 +334,4 @@ def generate_min_dependency_substitutions(app):
def setup(app):
app.connect("builder-inited", generate_min_dependency_table)
app.connect("builder-inited", generate_min_dependency_substitutions)
app.add_js_file("js/copybutton.js")
app.add_css_file("basic.css")
1 change: 1 addition & 0 deletions imblearn/_min_dependencies.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
"mypy": ("1.3.0", "tests"),
"sphinx": ("6.0.0", "docs"),
"sphinx-gallery": ("0.13.0", "docs"),
"sphinx-copybutton": ("0.5.2", "docs"),
"numpydoc": ("1.5.0", "docs"),
"sphinxcontrib-bibtex": ("2.4.1", "docs"),
"pydata-sphinx-theme": ("0.13.3", "docs"),
Expand Down