Skip to content
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

Jump to bottom

DOC: Use sphinx-copybutton extension in the documentation #168

Merged
merged 5 commits into from Apr 13, 2022
Merged

DOC: Use sphinx-copybutton extension in the documentation #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
aaceac6
DOC: Add sphinx-copybutton to docs/requirements.txt
sebastientourbier Apr 13, 2022
e34ac82
DOC: Add 'sphinx_copybutton' to extensions list in docs/conf.py
sebastientourbier Apr 13, 2022
cc4fccb
DOC: Add customization variable of sphinx-copybutton (commented for t…
sebastientourbier Apr 13, 2022
804bb73
DOC: Set copybutton prompt text regex [skip ci]
sebastientourbier Apr 13, 2022
e16fa9c
DOC: Simplify regex of copybutton [skip ci]
sebastientourbier Apr 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/conf.py
View file
Open in desktop
Expand Up @@ -62,6 +62,7 @@
'sphinxarg.ext',
'sphinx.ext.inheritance_diagram',
'sphinxcontrib.apidoc',
'sphinx_copybutton',
'matplotlib.sphinxext.plot_directive',
'nbsphinx',
'sphinx_gallery.load_style',
Expand Down Expand Up @@ -365,3 +366,17 @@

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {"http://docs.python.org/3": None}


# -- sphinx-copybutton extension configuration -------------------------------

copybutton_prompt_text = r">>> |\.\.\. |\$ | |\(py37cmp-gui\)\$ "
copybutton_prompt_is_regexp = True
# copybutton_only_copy_prompt_lines = False
copybutton_remove_prompts = True
# copybutton_copy_empty_lines = False
# copybutton_line_continuation_character = "\\"
# copybutton_here_doc_delimiter = "EOT"

# See https://sphinx-copybutton.readthedocs.io/en/latest/use.html#keep-empty-lines
# for more details
1 change: 1 addition & 0 deletions docs/requirements.txt
View file
Open in desktop
Expand Up @@ -8,6 +8,7 @@ sphinx-gallery==0.10.1
recommonmark==0.7.1
readthedocs-sphinx-ext==2.1.4
sphinx-autodoc-typehints==1.12.0
sphinx-copybutton==0.5.0
traits==6.3.2
traitsui==7.2.0
grabbit
Expand Down